API Docs
API Docs
  1. Schemas
  • Getting Started
    • Introduction to Sales Tax Calculation
    • Step By Step - Creating your first transaction
    • Step By Step - Creating VAT / Global Tax Transaction
  • Endpoints
    • Authentication
      • Authentication - Getting Started
      • Create JWT
    • Customers
      • Get to Know
      • Get Customer
      • Get All Customers
      • Upsert Customer
      • Update Customer
    • Exemptions
      • Get to Know
      • Get All Exemptions
      • Post Exemption
      • Update Exemption
      • Patch Exemption
    • Transactions
      • Get to Know
      • The Importance of Shipping Address
      • How to Use Credit Memos
      • Get Transaction (thin)
      • Get Transaction
      • Upsert Transaction
      • Delete Transaction
      • Get All Transactions (thin)
      • Get All Transactions
      • Upsert VAT / GT Transactio
    • Address Validation
      • Address Validation Intro
      • Validate Address
    • Sales Tax Rates
      • Get Sales Tax Rates
    • Vat Validation
      • Validate Vat
  • Special Features
    • Global Tax Rate
    • Partial Address
    • Discounts
    • Inclusive Tax
    • Vat Validation
    • Post exemptions from CSV
  • Applications
    • Xero - Integration & User Manual
  • Schemas
    • Schemas
      • Item Response
      • Item Request
      • ExchangeRateInfo
      • shippingAddress Copy
      • transaction Copy
      • transaction (thin)
      • Item (thin)
      • SalesTaxRates (thin)
      • GtRates (thin)
      • ShippingFee (thin)
      • Address Response
      • SalesTaxRates Response
      • Referral
      • Partnership
      • internalTimestamps
      • externalTimestamps
      • ShippingFee
      • billingAddress
      • addressOfCustomer
      • timestamp
      • Certificate
      • Classification
      • Exemption
      • State
      • Status
      • TimestampsDto
      • validationDates
      • ClientTrackingDto
      • EconomicNexusTracker
      • NexusCalculationSummaryDto
      • NexusDto
      • NexusStateRuleDto
      • NexusThresholdDto
      • PhysicalNexusTracker
      • SalesTaxTracking
      • Customer
      • GtRates
      • Item
      • JurisdictionalSalesTaxRules
      • RatesMetaData
      • SalesTax
      • SalesTaxRates
      • SubJurisdictionalTaxRules
      • transaction Request
      • transaction Response
      • transaction
      • shippingAddress
API Docs
API Docs
  1. Schemas

SalesTax

The sales tax breakdown for the transaction, including the amount and rates by jurisdictions. if tax may apply, contains either salestax rates or gt rates

{
    "amount": 0,
    "rate": 0,
    "salesTaxRates": {
        "cityRate": 0,
        "countyRate": 0,
        "stateRate": 0,
        "taxRate": 0,
        "combinedDistrictRate": 0,
        "ratesMetaData": {
            "cityDistrictRate": 0,
            "countyDistrictRate": 0
        }
    },
    "gtRates": {
        "countryRate": 0,
        "regionRate": 0,
        "taxRate": 0
    }
}
Built with