Lookup by Postal Address
Learn about tax area lookups by postal address.
Lookup tax area by postal address
| Endpoint | Method | Key value | Required field |
|---|---|---|---|
/v2/address-lookup | POST | postalAddress | postalAddress |
This request retrieves tax area information using a postal address as the criteria. The address lookup process takes an address and attempts to verify and cleanse the address by determining possible Vertex-defined tax areas and associated jurisdictions.
Sample request - Lookup by address
{
"asOfDate": "2024-03-07",
"postalAddress": {
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string"
},
"returnTimeElapsedDetailsIndicator": true
}
Sample response - Lookup by address
{
"data": {
"accumulationCustomerNumber": "string",
"accumulationDocumentNumber": "string",
"billingType": "string",
"companyCodeCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"currencyConversionFactors": [
{
"conversionFactor": 0,
"sourceCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"targetCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
}
}
],
"customer": {
"administrativeDestination": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"customerCode": {
"classCode": "string",
"isBusinessIndicator": true,
"value": "string"
},
"destination": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"exemptionCertificate": {
"exemptionCertificateNumber": "string",
"value": "string"
},
"exemptionReasonCode": "string",
"isTaxExempt": true,
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"isoCountryCode": "string",
"jurisdictionId": "string",
"mainDivision": "string",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
}
],
"taxRegistrationNumber": "string",
"filingCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"taxRegistrationType": "VAT Registration"
}
]
},
"deliveryTerm": "EXW",
"discount": {
"discountType": "DiscountAmount",
"discountValue": 0,
"userDefinedDiscountCode": "string"
},
"documentDate": "2024-03-04",
"documentNumber": "string",
"documentSequenceId": "string",
"documentType": "string",
"exemptOverrides": [
{
"amount": 0,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO",
"reasonCode": "string"
}
],
"impositionInclusions": [
{
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO"
}
],
"isTaxOnlyAdjustmentIndicator": true,
"lineItems": [
{
"amountBilledToDate": 0,
"assistedParameters": [
{
"originalValue": "string",
"paramName": "string",
"phase": "PRE",
"ruleName": "string",
"value": "string"
}
],
"chainTransactionPhase": "MANUFACTURER",
"commodityCode": {
"commodityCodeType": "string",
"usedCommodityCode": "string",
"userDefined": true,
"value": "string"
},
"companyCodeCurrencyTaxAmount": 0,
"companyCodeCurrencyTaxableAmount": 0,
"costCenter": "string",
"countryOfOriginISOCode": "string",
"customer": {
"administrativeDestination": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"customerCode": {
"classCode": "string",
"isBusinessIndicator": true,
"value": "string"
},
"destination": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"exemptionCertificate": {
"exemptionCertificateNumber": "string",
"value": "string"
},
"exemptionReasonCode": "string",
"isTaxExempt": true,
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"isoCountryCode": "string",
"jurisdictionId": "string",
"mainDivision": "string",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
}
],
"taxRegistrationNumber": "string",
"filingCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"taxRegistrationType": "VAT Registration"
}
]
},
"deliveryTerm": "EXW",
"departmentCode": "string",
"discount": {
"discountType": "DiscountAmount",
"discountValue": 0,
"userDefinedDiscountCode": "string"
},
"exemptOverrides": [
{
"amount": 0,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO",
"reasonCode": "string"
}
],
"exportProcedure": "string",
"extendedPrice": 0,
"fairMarketValue": 0,
"flexibleFields": {
"flexibleCodeFields": [
{
"fieldId": 1,
"value": "string"
}
],
"flexibleDateFields": [
{
"fieldId": 1,
"value": "2024-03-04"
}
],
"flexibleNumericFields": [
{
"fieldId": 1,
"value": 0
}
]
},
"freight": 0,
"generalLedgerAccount": "string",
"impositionInclusions": [
{
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO"
}
],
"inputTotalTax": 0,
"intrastatCommodityCode": "string",
"isMulticomponent": true,
"lineItemId": "string",
"lineItemNumber": 0,
"lineItems": [
{}
],
"lineType": {
"accumulationLocation": "string",
"content": "string",
"direction": "string",
"status": "string",
"value": "string"
},
"lineTypes": [
{
"accumulationLocation": "string",
"basis": "string",
"content": "string",
"count": 0,
"direction": "string",
"lineTypeNumber": 0,
"status": "string",
"value": "string"
}
],
"locationCode": "string",
"materialCode": "string",
"materialOrigin": "string",
"modeOfTransport": 1,
"natureOfTransaction": 1,
"netMassKilograms": 1,
"nonTaxableOverrides": [
{
"amount": 0,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO",
"reasonCode": "string"
}
],
"product": {
"productClass": "string",
"value": "string"
},
"projectNumber": "string",
"quantity": {
"unitOfMeasure": "str",
"value": 0
},
"rateOverrides": [
{
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO",
"rate": 0
}
],
"returnsFields": {
"returnsCodeFields": [
{
"name": "string",
"value": "string"
}
],
"returnsDateFields": [
{
"name": "string",
"value": "2024-03-04"
}
],
"returnsIndicatorFields": [
{
"name": "string",
"value": true
}
],
"returnsNumericFields": [
{
"name": "string",
"value": 0
}
]
},
"seller": {
"administrativeOrigin": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"company": "string",
"department": "string",
"dispatcher": {
"dispatcherCode": {
"classCode": "string",
"value": "string"
},
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"isoCountryCode": "string",
"jurisdictionId": "string",
"mainDivision": "string",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
}
],
"taxRegistrationNumber": "string",
"filingCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"taxRegistrationType": "VAT Registration"
}
]
},
"division": "string",
"nexusIndicator": true,
"nexusReasonCode": "string",
"physicalOrigin": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"isoCountryCode": "string",
"jurisdictionId": "string",
"mainDivision": "string",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
}
],
"taxRegistrationNumber": "string",
"filingCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"taxRegistrationType": "VAT Registration"
}
],
"utilityProvider": "REGULATED_TAXPAYER"
},
"simplificationCode": "CONSIGNMENT",
"situsOverride": {
"taxingLocation": "ADMINISTRATIVE_DESTINATION"
},
"statisticalValue": {
"amount": 0,
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
}
},
"supplementaryUnit": {
"unitType": "string",
"value": 0
},
"taxDate": "2024-03-04",
"taxIncludedIndicator": true,
"taxOverride": {
"overrideReasonCode": "string",
"overrideType": "TAXABLE"
},
"taxes": [
{
"accumulateAsImposition": {
"impositionId": "string",
"userDefined": true,
"value": "string"
},
"accumulateAsImpositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"accumulateAsJurisdiction": {
"effectiveDate": "2024-03-04",
"expirationDate": "2024-03-04",
"externalJurisdictionCode": "string",
"jurisdictionId": "string",
"jurisdictionType": "APO",
"value": "string"
},
"accumulateAsLineType": {
"userDefined": true,
"value": "string"
},
"accumulationRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"assistedParameters": [
{
"originalValue": "string",
"paramName": "string",
"phase": "PRE",
"ruleName": "string",
"value": "string"
}
],
"basisApportionmentRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"basisReductionPercentage": 0,
"basisRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"blockingRecoverablePercent": 0,
"buyerRegistrationId": "string",
"calculatedTax": 0,
"calculationRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"certificateNumber": {
"certificateType": "string",
"value": "string"
},
"creditRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"dispatcherRegistrationId": "string",
"effectiveRate": 0,
"exempt": 0,
"exemptMeasure": {
"unitOfMeasure": "str",
"value": 0
},
"filingCategoryCode": 1,
"filingCurrencyAmounts": {
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"filingCalculatedTax": 0,
"filingExempt": 0,
"filingNonTaxable": 0,
"filingRecoverableAmount": 0,
"filingTaxable": 0,
"filingUnrecoverableAmount": 0
},
"imposition": {
"impositionId": "string",
"userDefined": true,
"value": "string"
},
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"includedTax": 0,
"inclusionRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"inputOutputType": "INPUT",
"invoiceTextCodes": [
0
],
"invoiceTexts": [
{
"code": "string",
"invoiceTextRuleId": "string",
"text": "string",
"userDefined": true
}
],
"isService": true,
"jurisdiction": {
"effectiveDate": "2024-03-04",
"expirationDate": "2024-03-04",
"externalJurisdictionCode": "string",
"jurisdictionId": "string",
"jurisdictionType": "APO",
"value": "string"
},
"markUpRate": 0,
"maxTaxIndicator": true,
"maxTaxRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"nominalRate": 0,
"nonTaxable": 0,
"nonTaxableMeasure": {
"unitOfMeasure": "str",
"value": 0
},
"notRegisteredIndicator": true,
"originalTax": 0,
"ownerRegistrationId": "string",
"partialExemptRecoverablePercent": 0,
"postCalculationEvaluationRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"rateClassification": "string",
"reasonCode": "string",
"recipientRegistrationId": "string",
"recoverableAmount": 0,
"recoverablePercent": 0,
"recoverableRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"reportingBasis": 0,
"reportingBasisRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"sellerRegistrationId": "string",
"situs": "ADMINISTRATIVE_DESTINATION",
"summaryInvoiceText": "string",
"taxApportionmentRate": 0,
"taxApportionmentRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"taxCode": "string",
"taxCollectedFromParty": "SELLER",
"taxRateAdjustmentRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"taxResult": "TAXABLE",
"taxStructure": "BRACKET",
"taxType": "SALES",
"taxable": 0,
"taxableMeasure": {
"unitOfMeasure": "str",
"value": 0
},
"telecomUnitConversionRuleId": {
"salesTaxHolidayIndicator": true,
"userDefined": true,
"value": "string"
},
"unrecoverableAmount": 0,
"vertexTaxCode": "string"
}
],
"titleTransfer": "ORIGIN",
"totalTax": 0,
"transactionType": "SALE",
"unitPrice": 0,
"usage": "string",
"usageClass": "string",
"vendorSKU": "string",
"volume": {
"unitOfMeasure": "str",
"value": 0
},
"weight": {
"unitOfMeasure": "str",
"value": 0
}
}
],
"locationCode": "string",
"nonTaxableOverrides": [
{
"amount": 0,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO",
"reasonCode": "string"
}
],
"orderType": "string",
"originalCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"paymentDate": "2024-03-04",
"postToJournal": true,
"postingDate": "2024-03-04",
"proratePercentage": -100000000,
"rateOverrides": [
{
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"jurisdictionType": "APO",
"rate": 0
}
],
"returnAssistedParametersIndicator": true,
"returnGeneratedLineItemsIndicator": true,
"roundAtLineLevel": true,
"saleMessageType": "QUOTATION",
"seller": {
"administrativeOrigin": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"company": "string",
"department": "string",
"dispatcher": {
"dispatcherCode": {
"classCode": "string",
"value": "string"
},
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"isoCountryCode": "string",
"jurisdictionId": "string",
"mainDivision": "string",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
}
],
"taxRegistrationNumber": "string",
"filingCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"taxRegistrationType": "VAT Registration"
}
]
},
"division": "string",
"nexusIndicator": true,
"nexusReasonCode": "string",
"physicalOrigin": {
"city": "string",
"country": "string",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"rate": 0
},
"externalJurisdictionCode": "string",
"latitude": "string",
"locationCode": "string",
"locationCustomsStatus": "FREE_CIRCULATION",
"longitude": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
},
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "string",
"userDefined": true,
"value": "string",
"withholdingType": "string"
},
"isoCountryCode": "string",
"jurisdictionId": "string",
"mainDivision": "string",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "string",
"country": "string",
"mainDivision": "string",
"postalCode": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"subDivision": "string",
"taxAreaId": "string"
}
],
"taxRegistrationNumber": "string",
"filingCurrency": {
"isoCurrencyCodeAlpha": "string",
"isoCurrencyCodeNum": 0,
"isoCurrencyName": "string"
},
"taxRegistrationType": "VAT Registration"
}
],
"utilityProvider": "REGULATED_TAXPAYER"
},
"simplificationCode": "CONSIGNMENT",
"situsOverride": {
"taxingLocation": "ADMINISTRATIVE_DESTINATION"
},
"subTotal": 0,
"taxOverride": {
"overrideReasonCode": "string",
"overrideType": "TAXABLE"
},
"taxPointDate": "2024-03-04",
"total": 0,
"totalTax": 0,
"transactionId": "string",
"transactionType": "SALE"
},
"meta": {
"app": "string",
"timeElapsed(ms)": 0,
"timeReceived": "2024-03-04T20:03:08Z",
"timeElapsedDetails": [
{
"key": "string",
"value": "string"
}
]
}
}
Updated 3 months ago