Jump to Content
Vertex for e-CommerceGuidesAPI Reference
HomeGuidesAPI Reference
GuidesAPI ReferenceLog InVertex for e-Commerce
Guides
Log In
HomeGuidesAPI Reference

Getting Started

  • Product Overview
    • Features
    • Vertex for e-Commerce
    • Vertex Advantage Plus
    • Taxamo Assure
    • Vertex Invoice IQ
    • Vertex Validator
    • Supported Countries and Regions
  • Getting Started
    • Introductory Concepts
    • Integration Options
    • Single Sign On (SSO) with Okta
    • Test and Live Modes
  • Release Notes
    • Tax Rate Changes
    • Release Notes for 2024
    • Release Notes for 2023
    • Release Notes for 2022
  • Appendix
    • Glossary
    • Name Changes
    • Versions
    • Copyright Notice

Direct API Integrations

  • Getting Started with the API
    • Retrieving Access Tokens
    • Example Direct API Integration
  • Transaction Modeling
    • Mandatory and Required Fields
    • Transactions
    • Transaction Keys
    • Tax Inclusive and Exclusive Pricing
    • Currencies
    • Location Evidence
    • Subscriptions
    • Mapping Company IDs to Customer Codes
    • Invoice IQ Integration
    • B2B Transaction Processing
    • Refunds
    • Important Fields
    • Dictionaries
    • Error Message Guide
    • Indonesia
  • US Sales Overview
    • Tax Calculation
    • Address Validation
    • Tax Categories
    • Exemption Certification
    • Product Tax Codes

Non-API Integrations

  • Checkout Form Overview
    • Configuring Stripe as a Payment Provider
    • Configuring PayPal as a Payment Provider
    • Integrating the Checkout form with your Webstore
    • One-time Sales
    • Subscriptions
    • Customization
    • JavaScript API
    • Subscriptions for Stripe
  • Webhooks Overview
    • Vertex Webhooks
      • Vertex Webhooks Example
    • Stripe Webhooks
  • Connectors
    • Zuora
  • Drop-In UI Overview
    • Components
    • Data Attributes
    • JavaScript API
    • Events

Vertex Invoice IQ

  • Vertex Invoice IQ
    • Integrated Vertex Invoice IQ
    • Standalone Vertex Invoice IQ
      • Informative Invoices
    • Invoice Support per Country
    • Invoice Settings
    • Email Settings
    • Invoice Templates
    • Invoice Security
    • Invoices for Subscriptions

Vertex Validator

  • Vertex Validator
    • External Validation Service Downtimes
    • Integrated Vertex Validator
      • Validating Multiple Tax IDs for Canada
      • VAT Status Cache
    • Standalone Vertex Validator
    • Validation Type per Country
    • Egypt Configuration
    • CAPTCHA Validation
    • Redacted Responses
  • Bulk Tax ID Validations
    • Bulk Validation Request
    • Poll Results Request

Dashboard

  • Dashboard Overview
  • International VAT/GST UI
  • Transaction UIs
    • List UI
    • Manual Transactions
    • Bulk Transaction Uploads
  • Settings
    • Account Settings UI
      • User Roles
      • Enabling Multi-Factor Authentication
    • Country Settings
    • Invoice Settings
    • Threshold Monitoring
  • Reports
    • Settlement Report
    • Detailed Settlement Report
    • B2B Reports
  • Logs
  • Troubleshooting Guide
    • Cannot Find Invoices
    • eGUI Number Pool for Taiwan is too small
    • VAT Number is Invalid
    • Cannot find Vertex Advantage Plus Documents
    • Cannot find Taiwan eGUI Documents
    • Troubleshooting SSO
      • Permission Denied Errors for SSO
      • Cannot Log in to Okta
      • Cannot View SSO SAML Section

API Reference Guide

  • Reference Guide Overview
  • Requests
    • Calculate tax
    • Validate VAT number
    • Confirm transaction
    • Un-confirm transaction
    • Retrieve full transaction
    • Store transaction
    • Browse transactions
    • Retrieve transaction
    • Cancel transaction
    • Cancel refund by subnumber
    • Create a Refund
    • Bulk Refunds
    • Get transaction refunds
    • Cancel refund
    • Get refund details
    • Get event data
    • List Detailed Settlement Reports
    • Download Detailed Settlement Report
  • Fields
    • Transaction Schema
    • Vertex Validator Schema
    • Address Schema
    • Countries Schema (For Location Evidence)
    • Location Evidence Schema
    • Additional Interactions Schema
    • Additional Currency Schema
    • Refunds Schema
    • US Tax ID Schema
    • Tax Components Schema
  • Dictionaries
    • Product Types
    • Countries
    • Currencies