Skip to content
ShipVAT

Enums & Types Reference

Enums & Types Reference

This page documents all enums and types used throughout the ShipVAT API.

Tax Types

Used in rate queries to filter by type of tax.

ValueDescription
VATValue Added Tax (EU, UK)
GSTGoods and Services Tax (Canada federal, Australia)
HSTHarmonized Sales Tax (Canada - ON, NB, NS, NL, PE)
PSTProvincial Sales Tax (Canada - BC, SK, MB)
QSTQuebec Sales Tax (Canada - QC)
SALES_TAXState Sales Tax (US)
type TaxType = 'VAT' | 'GST' | 'HST' | 'PST' | 'QST' | 'SALES_TAX';

Rate Categories

Categories of tax rates within a jurisdiction.

ValueDescription
STANDARDStandard rate (most goods and services)
REDUCEDReduced rate (essentials, specific goods)
ZEROZero-rated (exports, certain food items)
SUPER_REDUCEDSuper-reduced rate (some EU countries)
type RateCategory = 'STANDARD' | 'REDUCED' | 'ZERO' | 'SUPER_REDUCED';

Jurisdiction Types

Classification of supported jurisdictions.

ValueDescriptionExamples
EU_COUNTRYEU member stateDE, FR, IT, ES, NL
COUNTRYNon-EU countryGB, AU, NO, CH
US_STATEUS state or territoryUS-CA, US-NY, US-TX
CA_PROVINCECanadian province/territoryCA-ON, CA-QC, CA-BC
SUPRANATIONALSupranational entityEU
type JurisdictionType =
  | 'COUNTRY'
  | 'EU_COUNTRY'
  | 'US_STATE'
  | 'CA_PROVINCE'
  | 'SUPRANATIONAL';

Threshold Types

Types of registration/nexus thresholds.

ValueDescriptionRegions
VAT_REGISTRATIONDomestic VAT registration thresholdEU, UK
REMOTE_SELLER_NEXUSEconomic nexus for remote sellersUS states
PST_REMOTE_SELLERPST threshold for remote sellersCA-BC, CA-SK, CA-MB
GST_SMALL_SUPPLIERGST small supplier exemptionCanada, Australia
EU_OSS_THRESHOLDEU One-Stop Shop thresholdEU (cross-border)
type ThresholdType =
  | 'VAT_REGISTRATION'
  | 'REMOTE_SELLER_NEXUS'
  | 'PST_REMOTE_SELLER'
  | 'GST_SMALL_SUPPLIER'
  | 'EU_OSS_THRESHOLD';

Threshold Conditions

How multiple criteria (amount + transactions) are evaluated.

ValueDescriptionExample
ORMeet either amount OR transaction countCA: $500k OR 200 transactions
ANDMust meet both amount AND transaction countNY: $500k AND 100 transactions
AMOUNT_ONLYOnly amount threshold appliesMost EU countries
TX_ONLYOnly transaction count appliesRare
type ThresholdCondition = 'OR' | 'AND' | 'AMOUNT_ONLY' | 'TX_ONLY';

Measurement Periods

Time periods for threshold evaluation.

ValueDescription
previous_calendar_yearJan 1 - Dec 31 of prior year
current_calendar_yearJan 1 - Dec 31 of current year
last_12_monthsRolling 12-month period
type Period = 'previous_calendar_year' | 'current_calendar_year' | 'last_12_months';

Data Status

Quality status of rate/threshold data.

ValueDescription
VERIFIEDConfirmed from official source
UNVERIFIEDPending verification
type DataStatus = 'VERIFIED' | 'UNVERIFIED';

Sync Status

Status of data collector jobs.

ValueDescription
SUCCESSLast sync completed successfully
FAILEDLast sync encountered an error
RUNNINGSync currently in progress
type SyncStatus = 'SUCCESS' | 'FAILED' | 'RUNNING';

Subscription Tiers

API access tiers and their limits.

TierRate LimitPrice
free10 req/min$0
pro1,000 req/min$49/month
enterprise10,000 req/minCustom
type SubscriptionTier = 'free' | 'pro' | 'enterprise';

Jurisdiction Codes

EU Countries (27)

CodeCountry
ATAustria
BEBelgium
BGBulgaria
HRCroatia
CYCyprus
CZCzechia
DKDenmark
EEEstonia
FIFinland
FRFrance
DEGermany
GRGreece
HUHungary
IEIreland
ITItaly
LVLatvia
LTLithuania
LULuxembourg
MTMalta
NLNetherlands
PLPoland
PTPortugal
RORomania
SKSlovakia
SISlovenia
ESSpain
SESweden

Other Countries

CodeCountry
GBUnited Kingdom
AUAustralia
NONorway
CHSwitzerland
ISIceland

US States (50 + DC)

CodeStateHas Sales Tax
US-ALAlabama✓
US-AKAlaska✓ (local only)
US-AZArizona✓
US-ARArkansas✓
US-CACalifornia✓
US-COColorado✓
US-CTConnecticut✓
US-DEDelaware✗
US-DCDistrict of Columbia✓
US-FLFlorida✓
US-GAGeorgia✓
US-HIHawaii✓
US-IDIdaho✓
US-ILIllinois✓
US-INIndiana✓
US-IAIowa✓
US-KSKansas✓
US-KYKentucky✓
US-LALouisiana✓
US-MEMaine✓
US-MDMaryland✓
US-MAMassachusetts✓
US-MIMichigan✓
US-MNMinnesota✓
US-MSMississippi✓
US-MOMissouri✓
US-MTMontana✗
US-NENebraska✓
US-NVNevada✓
US-NHNew Hampshire✗
US-NJNew Jersey✓
US-NMNew Mexico✓
US-NYNew York✓
US-NCNorth Carolina✓
US-NDNorth Dakota✓
US-OHOhio✓
US-OKOklahoma✓
US-OROregon✗
US-PAPennsylvania✓
US-RIRhode Island✓
US-SCSouth Carolina✓
US-SDSouth Dakota✓
US-TNTennessee✓
US-TXTexas✓
US-UTUtah✓
US-VTVermont✓
US-VAVirginia✓
US-WAWashington✓
US-WVWest Virginia✓
US-WIWisconsin✓
US-WYWyoming✓

No Sales Tax States: Delaware (DE), Montana (MT), New Hampshire (NH), Oregon (OR). Alaska has no state sales tax but allows local taxes.

Canadian Provinces (13)

CodeProvince/TerritoryTax Types
CA-ABAlbertaGST only
CA-BCBritish ColumbiaGST + PST
CA-MBManitobaGST + PST
CA-NBNew BrunswickHST
CA-NLNewfoundland and LabradorHST
CA-NTNorthwest TerritoriesGST only
CA-NSNova ScotiaHST
CA-NUNunavutGST only
CA-ONOntarioHST
CA-PEPrince Edward IslandHST
CA-QCQuebecGST + QST
CA-SKSaskatchewanGST + PST
CA-YTYukonGST only

Error Codes

API error responses include these codes:

CodeHTTP StatusDescription
UNAUTHORIZED401Invalid or missing API key
RATE_LIMIT_EXCEEDED429Too many requests
VALIDATION_ERROR400Invalid request parameters
INVALID_DATE_FORMAT400Date not in YYYY-MM-DD format
JURISDICTION_NOT_SUPPORTED404Unknown jurisdiction code
RATE_NOT_FOUND404No rate for jurisdiction/date
THRESHOLD_NOT_FOUND404No threshold for jurisdiction
DATA_STALE503Data sync failed, may be outdated
INTERNAL_ERROR500Unexpected server error