Tax Engine
  1. Schemas
Tax Engine
  • 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
  • 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
  1. Schemas

transaction Request

A transaction between the API consumer and a customer

{
    "externalId": "string",
    "source": "string",
    "documentName": "string",
    "items": [
        {
            "unitPrice": 0,
            "quantity": 0,
            "totalPrice": 0,
            "description": "string",
            "name": "string",
            "taxCode": "string",
            "manualSalesTax": true,
            "manualSalesTaxRate": 0.2,
            "discount": 0
        }
    ],
    "isTaxInclusive": true,
    "billingAddress": {
        "city": "string",
        "country": "string",
        "county": "string",
        "state": "string",
        "street": "string",
        "region": "string",
        "zip": "string"
    },
    "shippingAddress": {
        "city": "string",
        "country": "string",
        "county": "string",
        "state": "string",
        "street": "string",
        "region": "string",
        "zip": "string",
        "isPartial": true,
        "matchedAddressData": {
            "address": {
                "city": "string",
                "country": "string",
                "county": "string",
                "state": "string",
                "zip": "string"
            },
            "scoring": {
                "matchLevel": "string",
                "score": 0,
                "fieldScore": {
                    "countryMatch": "string",
                    "stateMatch": "string",
                    "cityMatch": "string",
                    "zipMatch": "string"
                }
            }
        }
    },
    "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
    "customerExternalId": "string",
    "customerSource": "string",
    "transactionStatus": "ACTIVE",
    "externalTimestamps": {
        "createdDate": "string",
        "updatedDate": "string"
    },
    "transactionType": "SALES_ORDER",
    "shippingFee": {
        "manualSalesTax": true,
        "manualSalesTaxRate": 0,
        "totalPrice": 0,
        "taxCode": "string",
        "salesTaxRates": {
            "cityRate": 0,
            "countyRate": 0,
            "stateRate": 0,
            "taxRate": 0,
            "combinedDistrictRate": 0,
            "ratesMetaData": {
                "cityDistrictRate": 0,
                "countyDistrictRate": 0
            }
        },
        "gtRates": {
            "countryRate": 0,
            "regionRate": 0,
            "taxRate": 0
        }
    },
    "createdFrom": "string",
    "transactionLevelDiscount": 0,
    "transactionFilingStatus": "NOT_FILED",
    "currency": "string",
    "refRate": 0,
    "subsidiary": "string",
    "isRefundLinked": true
}
Built with