Examples

Get an overview of some example requests and responses.

You can use these examples with the Calculate Tax as a Seller request.

Single Tax ID

This example shows a single Tax ID being validated against VIES.

Request

{

    "saleMessageType": "QUOTATION",
    "lineItems": [
        {
            "customer": {
                "customerName": "Swatch",
                "destination": {
                    "country": "CH"
                },
                "taxRegistrations": [
                    {
                        "taxRegistrationNumber": "CHCHE-116.294.121",
                        "taxRegistrationType": "VAT Registration"
                    },
                    {
                        "taxRegistrationNumber": "GB473116503"
                    }
                ]
            },
            "extendedPrice": 100
        },
        {
            "customer": {
                "customerCode": {
                    "value": "orlen"
                },
                "customerName": "Orlen",
                "destination": {
                    "country": "Poland"
                },
                "taxRegistrations": [
                    {
                        "isoCountryCode": "PL",
                        "taxRegistrationNumber": "PL774-00-01-454",
                        "taxRegistrationType": "VAT Registration"
                    }
                ]
            },
            "extendedPrice": 100
        }
    ],
    "seller": {
        "company": "demoSeller",
        "physicalOrigin": {
            "country": "FR"
        }
    },
    "transactionType": "SALE"
}

Response

{
    "data": {
        "documentDate": "2025-07-23",
        "lineItems": [
            {
                "customer": {
                    "customerName": "MWST-Gruppe, The Swatch Group SA",
                    "destination": {
                        "country": "CH",
                        "taxAreaId": "807560000"
                    },
                    "taxRegistrations": [
                        {
                            "isoCountryCode": "CH",
                            "taxRegistrationNumber": "CHCHE-116.294.121",
                            "taxRegistrationType": "VAT Registration",
                            "validationResult": {
                                "cacheTimestamp": "2025-07-23T09:35:34.4650Z",
                                "cached": true,
                                "isSyntaxValid": true,
                                "isValid": true,
                                "name": "MWST-Gruppe, The Swatch Group SA",
                                "taxNumberService": "uid.admin.ch",
                                "taxRegistrationNumberNormalized": "CHE116.294.121",
                                "validationInfo": "tax-number-valid-according-to-external-service"
                            }
                        },
                        {
                            "isoCountryCode": "GB",
                            "taxRegistrationNumber": "GB473116503",
                            "validationResult": {
                                "address": "BUILDING 1000\nTHE ROYALS BUSINESS PARK\nLONDON\nE16 2QU\nGB",
                                "cacheTimestamp": "2025-07-23T09:35:34.0210Z",
                                "cached": true,
                                "isSyntaxValid": true,
                                "isValid": true,
                                "name": "THE SWATCH GROUP (UK) LIMITED",
                                "taxNumberService": "tax.service.gov.uk",
                                "taxRegistrationNumberNormalized": "473116503",
                                "validationInfo": "tax-number-valid-according-to-external-service"
                            }
                        }
                    ]
                },
                "extendedPrice": 100.0,
                "fairMarketValue": 100.0,
                "quantity": {
                    "value": 1.0
                },
                "seller": {
                    "company": "demoSeller",
                    "physicalOrigin": {
                        "country": "FR",
                        "taxAreaId": "802500000"
                    },
                    "taxRegistrations": []
                },
                "taxIncludedIndicator": false,
                "taxes": [
                    {
                        "calculatedTax": 0.0,
                        "effectiveRate": 0.0,
                        "exempt": 0.0,
                        "invoiceTextCodes": [
                            1,
                            16
                        ],
                        "isService": false,
                        "jurisdiction": {
                            "effectiveDate": "1900-01-01",
                            "expirationDate": "9999-12-31",
                            "jurisdictionId": "78282",
                            "jurisdictionType": "COUNTRY",
                            "value": "FRANCE"
                        },
                        "maxTaxIndicator": false,
                        "nonTaxable": 0.0,
                        "notRegisteredIndicator": false,
                        "situs": "PHYSICAL_ORIGIN",
                        "taxCollectedFromParty": "BUYER",
                        "taxRateReductionExempt": 0.0,
                        "taxResult": "NO_TAX",
                        "taxType": "NONE",
                        "taxable": 0.0
                    }
                ],
                "totalTax": 0.0,
                "transactionType": "SALE"
            },
            {
                "customer": {
                    "customerCode": {
                        "isBusinessIndicator": true,
                        "value": "orlen"
                    },
                    "customerName": "ORLEN SPÓŁKA AKCYJNA",
                    "destination": {
                        "country": "Poland",
                        "taxAreaId": "806160000"
                    },
                    "isTaxExempt": false,
                    "taxRegistrations": [
                        {
                            "isoCountryCode": "PL",
                            "taxRegistrationNumber": "PL774-00-01-454",
                            "taxRegistrationType": "VAT Registration",
                            "validationResult": {
                                "address": "CHEMIKÓW 7\n09-411 PŁOCK",
                                "cacheTimestamp": "2025-07-23T09:35:34.0000Z",
                                "cached": true,
                                "isSyntaxValid": true,
                                "isValid": true,
                                "name": "ORLEN SPÓŁKA AKCYJNA",
                                "taxNumberService": "vies",
                                "taxRegistrationNumberNormalized": "7740001454",
                                "validationInfo": "tax-number-valid-according-to-external-service"
                            }
                        }
                    ]
                },
                "extendedPrice": 100.0,
                "fairMarketValue": 100.0,
                "quantity": {
                    "value": 1.0
                },
                "seller": {
                    "company": "demoSeller",
                    "physicalOrigin": {
                        "country": "FR",
                        "taxAreaId": "802500000"
                    },
                    "taxRegistrations": []
                },
                "taxIncludedIndicator": false,
                "taxes": [
                    {
                        "buyerRegistrationId": "PL774-00-01-454",
                        "calculatedTax": 0.0,
                        "effectiveRate": 0.0,
                        "exempt": 0.0,
                        "invoiceTextCodes": [
                            2,
                            16
                              ],
                        "isService": false,
                        "jurisdiction": {
                            "effectiveDate": "1900-01-01",
                            "expirationDate": "9999-12-31",
                            "jurisdictionId": "78282",
                            "jurisdictionType": "COUNTRY",
                            "value": "FRANCE"
                        },
                        "maxTaxIndicator": false,
                        "nonTaxable": 0.0,
                        "notRegisteredIndicator": false,
                        "situs": "PHYSICAL_ORIGIN",
                        "taxCollectedFromParty": "BUYER",
                        "taxRateReductionExempt": 0.0,
                        "taxResult": "NO_TAX",
                        "taxType": "NONE",
                        "taxable": 0.0
                    }
                ],
                 "totalTax": 0.0,
                "transactionType": "SALE"
            }
        ],
        "returnAssistedParametersIndicator": true,
        "roundAtLineLevel": false,
        "saleMessageType": "QUOTATION",
        "seller": {
            "company": "demoSeller",
            "physicalOrigin": {
                "country": "FR",
                "taxAreaId": "802500000"
            },
            "taxRegistrations": []
        },
        "subTotal": 200.0,
        "total": 200.0,
        "totalTax": 0.0,
        "transactionType": "SALE"
    },
    "meta": {
        "app": "vertex-ws.war v9.0.20.1.25",
        "extension": "oseries-plus 20250722144320-9da1187d6204c073ac0dc4d6d8efec0f32544d28",
        "timeElapsed(ms)": 23,
        "timeReceived": "2025-07-23T09:36:56.632Z"
    }
}

Single Tax ID 2

This example also shows a single Tax ID.

Request

{
    "saleMessageType": "QUOTATION",
    "deliveryTerm": "SUP",
    "customer": {
        "customerCode": {
            "value": "customer1"
        },
        "destination": {
            "country": "Poland"
        },
        "taxRegistrations": [
            {
                "isoCountryCode": "PL",
                "taxRegistrationNumber": "PL774-00-01-454",
                "taxRegistrationType": "VAT Registration"
            }
        ]
    },
    "lineItems": [
        {
            "extendedPrice": 100,
            "seller": {
                "company": "seller1",
                "physicalOrigin": {
                    "country": "DE"
                }
            }
        }
    ],
    "transactionType": "SALE"
}

Response

{
    "data": {
        "customer": {
            "customerCode": {
                "isBusinessIndicator": true,
                "value": "customer1"
            },
            "customerName": "ORLEN SPÓŁKA AKCYJNA",
            "destination": {
                "country": "Poland",
                "taxAreaId": "806160000"
            },
            "isTaxExempt": false,
            "taxRegistrations": [
                {
                    "isoCountryCode": "PL",
                    "taxRegistrationNumber": "PL774-00-01-454",
                    "taxRegistrationType": "VAT Registration",
                    "validationResult": {
                        "address": "CHEMIKÓW 7\n09-411 PŁOCK",
                        "cacheTimestamp": "2025-07-23T09:35:34.0000Z",
                        "cached": true,
                        "isSyntaxValid": true,
                        "isValid": true,
                        "name": "ORLEN SPÓŁKA AKCYJNA",
                        "taxNumberService": "vies",
                        "taxRegistrationNumberNormalized": "7740001454",
                        "validationInfo": "TAX_NUMBER_VALID_ACCORDING_TO_EXTERNAL_SERVICE"
                    }
                }
            ]
        },
        "deliveryTerm": "SUP",
        "documentDate": "2025-07-23",
        "lineItems": [
            {
                "customer": {
                    "customerCode": {
                        "isBusinessIndicator": true,
                        "value": "customer1"
                    },
                    "customerName": "ORLEN SPÓŁKA AKCYJNA",
                    "destination": {
                        "country": "Poland",
                        "taxAreaId": "806160000"
                    },
                    "isTaxExempt": false,
                    "taxRegistrations": [
                        {
                            "isoCountryCode": "PL",
                            "taxRegistrationNumber": "PL774-00-01-454",
                            "taxRegistrationType": "VAT Registration",
                            "validationResult": {
                                "address": "CHEMIKÓW 7\n09-411 PŁOCK",
                                "cacheTimestamp": "2025-07-23T09:35:34.0000Z",
                                "cached": true,
                                "isSyntaxValid": true,
                                "isValid": true,
                                "name": "ORLEN SPÓŁKA AKCYJNA",
                                "taxNumberService": "vies",
                                "taxRegistrationNumberNormalized": "7740001454",
                                "validationInfo": "TAX_NUMBER_VALID_ACCORDING_TO_EXTERNAL_SERVICE"
                            }
                        }
                    ]
                },
                "deliveryTerm": "SUP",
                "extendedPrice": 100.0,
                "fairMarketValue": 100.0,
                "quantity": {
                    "value": 1.0
                },
                "seller": {
                    "company": "seller1",
                    "physicalOrigin": {
                        "country": "DE",
                        "taxAreaId": "802760004"
                    },
                    "taxRegistrations": []
                },
                "taxIncludedIndicator": false,
                "taxes": [
                    {
                        "calculatedTax": 0.0,
                        "effectiveRate": 0.0,
                        "exempt": 0.0,
                        "invoiceTextCodes": [
                            1,
                            16
                        ],
                        "isService": false,
                        "jurisdiction": {
                            "effectiveDate": "1900-01-01",
                            "expirationDate": "9999-12-31",
                            "jurisdictionId": "89445",
                            "jurisdictionType": "COUNTRY",
                            "value": "HELIGOLAND"
                        },
                        "maxTaxIndicator": false,
                        "nonTaxable": 0.0,
                        "notRegisteredIndicator": false,
                        "situs": "PHYSICAL_ORIGIN",
                        "taxCollectedFromParty": "BUYER",
                        "taxRateReductionExempt": 0.0,
                        "taxResult": "NO_TAX",
                        "taxType": "NONE",
                        "taxable": 0.0
                    },
                    {
                        "buyerRegistrationId": "PL774-00-01-454",
                        "calculatedTax": 23.0,
                        "calculationRuleId": {
                            "salesTaxHolidayIndicator": false,
                            "userDefined": false,
                            "value": "v301086010"
                        },
                        "effectiveRate": 0.23,
                        "exempt": 0.0,
                        "imposition": {
                            "impositionId": "1",
                            "jurisdictionId": "78327",
                            "userDefined": false,
                            "value": "VAT"
                        },
                        "impositionType": {
                            "impositionTypeId": "v19",
                            "userDefined": false,
                            "value": "VAT"
                        },
                        "inputOutputType": "OUTPUT",
                        "invoiceTextCodes": [
                            9,
                            18,
                            21
                        ],
                        "isService": false,
                        "jurisdiction": {
                            "effectiveDate": "1900-01-01",
                            "expirationDate": "9999-12-31",
                            "jurisdictionId": "78327",
                            "jurisdictionType": "COUNTRY",
                            "value": "POLAND"
                        },
                        "maxTaxIndicator": false,
                        "nominalRate": 0.23,
                        "nonTaxable": 0.0,
                        "notRegisteredIndicator": false,
                        "postCalculationEvaluationRuleId": {
                            "salesTaxHolidayIndicator": false,
                            "userDefined": false,
                            "value": "v318456382"
                        },
                        "rateClassification": "Standard Rate",
                        "situs": "DESTINATION",
                        "taxCollectedFromParty": "BUYER",
                        "taxLiabilityOwner": "SELLER",
                        "taxLiabilityRule": "physical-shipment-inside-EU-b2b-intra-community",
                        "taxRateReductionExempt": 0.0,
                        "taxResult": "TAXABLE",
                        "taxStructure": "SINGLE_RATE",
                        "taxType": "VAT",
                        "taxable": 100.0
                    }
                ],
                "totalTax": 23.0,
                "transactionType": "SALE"
            }
        ],
        "returnAssistedParametersIndicator": true,
        "roundAtLineLevel": false,
        "saleMessageType": "QUOTATION",
        "subTotal": 100.0,
        "total": 123.0,
        "totalTax": 23.0,
        "transactionType": "SALE"
    },
    "meta": {
        "app": "vertex-ws.war v9.0.20.1.25",
        "extension": "oseries-plus 20250723095736-9b25506a74da7a403dc802e3b48c920b202ace1e",
        "timeElapsed(ms)": 15,
        "timeReceived": "2025-07-23T11:55:17.417Z"
    }
}

Invalid Tax ID

This example shows how the service responds when the Tax ID is invalid.

Request

{
    "saleMessageType": "QUOTATION",
    "deliveryTerm": "SUP",
    "customer": {
        "customerCode": {
            "value": "customer1"
        },
        "destination": {
            "country": "Poland"
        },
        "taxRegistrations": [
            {
                "isoCountryCode": "PL",
                "taxRegistrationNumber": "PL774-00-01-451",
                "taxRegistrationType": "VAT Registration"
            }
        ]
    },
    "lineItems": [
        {
            "extendedPrice": 100,
            "seller": {
                "company": "seller1",
                "physicalOrigin": {
                    "country": "DE"
                }
            }
        }
    ],
    "transactionType": "SALE"
}

Response

{
    "data": {
        "customer": {
            "customerCode": {
                "isBusinessIndicator": false,
                "value": "customer1"
            },
            "destination": {
                "country": "Poland",
                "taxAreaId": "806160000"
            },
            "isTaxExempt": false,
            "taxRegistrations": [
                {
                    "isoCountryCode": "PL",
                    "taxRegistrationNumber": "PL774-00-01-451",
                    "taxRegistrationType": "VAT Registration",
                    "validationResult": {
                        "cacheTimestamp": "2025-07-23T11:54:11.3610Z",
                        "cached": true,
                        "isSyntaxValid": true,
                        "isValid": false,
                        "taxNumberService": "vies",
                        "taxRegistrationNumberNormalized": "7740001451",
                        "validationInfo": "TAX_NUMBER_INVALID_ACCORDING_TO_EXTERNAL_SERVICE"
                    }
                }
            ]
        },
        "deliveryTerm": "SUP",
        "documentDate": "2025-07-23",
        "lineItems": [
            {
                "backToBackInvoice": {
                    "country": "DE"
                },
                "customer": {
                    "customerCode": {
                        "isBusinessIndicator": false,
                        "value": "customer1"
                    },
                    "destination": {
                        "country": "Poland",
                        "taxAreaId": "806160000"
                    },
                    "isTaxExempt": false,
                    "taxRegistrations": [
                        {
                            "isoCountryCode": "PL",
                            "taxRegistrationNumber": "PL774-00-01-451",
                            "taxRegistrationType": "VAT Registration",
                            "validationResult": {
                                "cacheTimestamp": "2025-07-23T11:54:11.3610Z",
                                "cached": true,
                                "isSyntaxValid": true,
                                "isValid": false,
                                "taxNumberService": "vies",
                                "taxRegistrationNumberNormalized": "7740001451",
                                "validationInfo": "TAX_NUMBER_INVALID_ACCORDING_TO_EXTERNAL_SERVICE"
                            }
                        }
                    ]
                },
                "deliveryTerm": "SUP",
                "extendedPrice": 100.0,
                "fairMarketValue": 100.0,
                "quantity": {
                    "value": 1.0
                },
                "seller": {
                    "company": "seller1",
                    "physicalOrigin": {
                        "country": "DE",
                        "taxAreaId": "802760000"
                    },
                    "taxRegistrations": []
                },
                "taxIncludedIndicator": false,
                "taxes": [
                    {
                        "calculatedTax": 0.0,
                        "effectiveRate": 0.0,
                        "exempt": 0.0,
                        "invoiceTextCodes": [
                            16,
                            27
                        ],
                        "isService": false,
                        "jurisdiction": {
                            "effectiveDate": "1900-01-01",
                            "expirationDate": "9999-12-31",
                            "jurisdictionId": "78283",
                            "jurisdictionType": "COUNTRY",
                            "value": "GERMANY"
                        },
                        "maxTaxIndicator": false,
                        "nonTaxable": 0.0,
                        "notRegisteredIndicator": false,
                        "situs": "PHYSICAL_ORIGIN",
                        "taxCollectedFromParty": "BUYER",
                        "taxRateReductionExempt": 0.0,
                        "taxResult": "NO_TAX",
                        "taxType": "NONE",
                        "taxable": 0.0
                    },
                    {
                        "calculatedTax": 23.0,
                        "calculationRuleId": {
                            "salesTaxHolidayIndicator": false,
                            "userDefined": false,
                            "value": "v301086010"
                        },
                        "effectiveRate": 0.23,
                        "exempt": 0.0,
                        "imposition": {
                            "impositionId": "1",
                            "jurisdictionId": "78327",
                            "userDefined": false,
                            "value": "VAT"
                        },
                        "impositionType": {
                            "impositionTypeId": "v19",
                            "userDefined": false,
                            "value": "VAT"
                        },
                        "inputOutputType": "OUTPUT",
                        "invoiceTextCodes": [
                            2,
                            27
                        ],
                        "isService": false,
                        "jurisdiction": {
                            "effectiveDate": "1900-01-01",
                            "expirationDate": "9999-12-31",
                            "jurisdictionId": "78327",
                            "jurisdictionType": "COUNTRY",
                            "value": "POLAND"
                        },
                        "maxTaxIndicator": false,
                        "nominalRate": 0.23,
                        "nonTaxable": 0.0,
                        "notRegisteredIndicator": false,
                        "postCalculationEvaluationRuleId": {
                            "salesTaxHolidayIndicator": false,
                            "userDefined": false,
                            "value": "v318456382"
                        },
                        "rateClassification": "Standard Rate",
                        "situs": "DESTINATION",
                        "taxCollectedFromParty": "BUYER",
                        "taxLiabilityOwner": "MARKETPLACE",
                        "taxLiabilityRule": "physical-shipment-inside-EU-seller-outside-EU",
                        "taxRateReductionExempt": 0.0,
                        "taxResult": "TAXABLE",
                        "taxStructure": "SINGLE_RATE",
                        "taxType": "VAT",
                        "taxable": 100.0
                    }
                ],
                "totalTax": 23.0,
                "transactionType": "SALE"
            }
        ],
        "returnAssistedParametersIndicator": true,
        "roundAtLineLevel": false,
        "saleMessageType": "QUOTATION",
        "subTotal": 100.0,
        "total": 123.0,
        "totalTax": 23.0,
        "transactionType": "SALE"
    },
    "meta": {
        "app": "vertex-ws.war v9.0.20.1.25",
        "extension": "oseries-plus 20250723095736-9b25506a74da7a403dc802e3b48c920b202ace1e",
        "timeElapsed(ms)": 21,
        "timeReceived": "2025-07-23T11:56:15.998Z"
    }
}

 

Validation off

The following example shows how to turn off validation in a request.

Request

{
    "saleMessageType": "QUOTATION",
    "deliveryTerm": "SUP",
    "customer": {
        "customerCode": {
            "value": "customer1"
        },
        "destination": {
            "country": "Poland"
        },
        "taxRegistrations": [
            {
                "isoCountryCode": "PL",
                "taxRegistrationNumber": "will-not-be-validated",
                "taxRegistrationType": "VAT Registration",
                "validationResult": {
                    "isValid": true
                }
            }
        ]
    },
    "lineItems": [
        {
            "extendedPrice": 100
        }
    ],
    "seller": {
        "company": "seller1",
        "physicalOrigin": {
            "country": "DE"
        }
    },
    "transactionType": "SALE"
}

Response

{
    "data": {
        "customer": {
            "customerCode": {
                "isBusinessIndicator": true,
                "value": "customer1"
            },
            "destination": {
                "country": "Poland",
                "taxAreaId": "806160000"
            },
            "isTaxExempt": false,
            "taxRegistrations": [
                {
                    "isoCountryCode": "PL",
                    "taxRegistrationNumber": "will-not-be-validated",
                    "taxRegistrationType": "VAT Registration",
                    "validationResult": {
                        "isValid": true
                    }
                }
            ]
        },
        "deliveryTerm": "SUP",
        "documentDate": "2025-07-23",
        "lineItems": [
            {
                "backToBackInvoice": {
                    "country": "DE"
                },
                "customer": {
                    "customerCode": {
                        "isBusinessIndicator": true,
                        "value": "customer1"
                    },
                    "destination": {
                        "country": "Poland",
                        "taxAreaId": "806160000"
                    },
                    "isTaxExempt": false,
                    "taxRegistrations": [
                        {
                            "isoCountryCode": "PL",
                            "taxRegistrationNumber": "will-not-be-validated",
                            "taxRegistrationType": "VAT Registration",
                            "validationResult": {
                                "isValid": true
                            }
                        }
                    ]
                },
                "deliveryTerm": "SUP",
                "extendedPrice": 100.0,
                "fairMarketValue": 100.0,
                "quantity": {
                    "value": 1.0
                },
                "seller": {
                    "company": "seller1",
                    "physicalOrigin": {
                        "country": "DE",
                        "taxAreaId": "802760004"
                    },
                    "taxRegistrations": []
                },
                "taxIncludedIndicator": false,
                "taxes": [
                    {
                        "calculatedTax": 0.0,
                        "effectiveRate": 0.0,
                        "exempt": 0.0,
                        "invoiceTextCodes": [
                            1,
                            16
                        ],
                        "isService": false,
                        "jurisdiction": {
                            "effectiveDate": "1900-01-01",
                            "expirationDate": "9999-12-31",
                            "jurisdictionId": "89445",
                            "jurisdictionType": "COUNTRY",
                            "value": "HELIGOLAND"
                        },
                        "maxTaxIndicator": false,
                        "nonTaxable": 0.0,
                        "notRegisteredIndicator": false,
                        "situs": "PHYSICAL_ORIGIN",
                        "taxCollectedFromParty": "BUYER",
                        "taxRateReductionExempt": 0.0,
                        "taxResult": "NO_TAX",
                        "taxType": "NONE",
                        "taxable": 0.0
                    },
                    {
                        "buyerRegistrationId": "will-not-be-validated",
                        "calculatedTax": 23.0,
                        "calculationRuleId": {
                            "salesTaxHolidayIndicator": false,
                            "userDefined": false,
                            "value": "v301086010"
                        },
                        "effectiveRate": 0.23,
                        "exempt": 0.0,
                        "imposition": {
                            "impositionId": "1",
                            "jurisdictionId": "78327",
                            "userDefined": false,
                            "value": "VAT"
                        },
                        "impositionType": {
                            "impositionTypeId": "v19",
                            "userDefined": false,
                            "value": "VAT"
                        },
                        "inputOutputType": "OUTPUT",
                        "invoiceTextCodes": [
                            9,
                            18,
                            21
                        ],
                        "isService": false,
                        "jurisdiction": {
                            "effectiveDate": "1900-01-01",
                            "expirationDate": "9999-12-31",
                            "jurisdictionId": "78327",
                            "jurisdictionType": "COUNTRY",
                            "value": "POLAND"
                        },
                        "maxTaxIndicator": false,
                        "nominalRate": 0.23,
                        "nonTaxable": 0.0,
                        "notRegisteredIndicator": false,
                        "postCalculationEvaluationRuleId": {
                            "salesTaxHolidayIndicator": false,
                            "userDefined": false,
                            "value": "v318456382"
                        },
                        "rateClassification": "Standard Rate",
                        "situs": "DESTINATION",
                        "taxCollectedFromParty": "BUYER",
                        "taxLiabilityOwner": "MARKETPLACE",
                        "taxLiabilityRule": "physical-shipment-inside-EU-seller-outside-EU",
                        "taxRateReductionExempt": 0.0,
                        "taxResult": "TAXABLE",
                        "taxStructure": "SINGLE_RATE",
                        "taxType": "VAT",
                        "taxable": 100.0
                    }
                ],
                "totalTax": 23.0,
                "transactionType": "SALE"
            }
        ],
        "returnAssistedParametersIndicator": true,
        "roundAtLineLevel": false,
        "saleMessageType": "QUOTATION",
        "seller": {
            "company": "seller1",
            "physicalOrigin": {
                "country": "DE",
                "taxAreaId": "802760004"
            },
            "taxRegistrations": []
        },
        "subTotal": 100.0,
        "total": 123.0,
        "totalTax": 23.0,
        "transactionType": "SALE"
    },
    "meta": {
        "app": "vertex-ws.war v9.0.20.1.25",
        "extension": "oseries-plus 20250723095736-9b25506a74da7a403dc802e3b48c920b202ace1e",
        "timeElapsed(ms)": 18,
        "timeReceived": "2025-07-23T11:57:12.306Z"
    }
}

delete

Syntax-only check

The following example shows a request and response for a syntax-only check. In this case, the Tax ID is not checked against the database. It is only checked to see that the ID is formatted in the correct way.

Request

{
  "saleMessageType": "QUOTATION",
  "deliveryTerm": "SUP",
  "customer": {
    "destination": {
      "country": "Poland"
    },
    "taxRegistrations": [
      {
        "isoCountryCode": "PL",
        "taxRegistrationNumber": "PL1111111111"
      }
    ]
  },
  "lineItems": [
    {
      "extendedPrice": 100
    }
  ],
  "currency": {
    "isoCurrencyCodeAlpha": "PLN"
  },
  "transactionType": "SALE",
  "seller": {
    "company": "seller_1",
    "physicalOrigin": {
      "country": "Germany"
    },
    "taxRegistrations": [
      {
        "isoCountryCode": "PL",
        "taxRegistrationNumber": "PL00001"
      }
    ]
  }
}
 

Response

{
  "data": {
    "currency": {
      "isoCurrencyCodeAlpha": "PLN",
      "isoCurrencyCodeNum": 0,
      "isoCurrencyName": "Zloty"
    },
    "customer": {
      "destination": {
        "country": "Poland",
        "taxAreaId": "806160000"
      },
      "taxRegistrations": [
        {
          "isoCountryCode": "PL",
          "taxRegistrationNumber": "PL1111111111",
          "validationResult": {
            "isSyntaxValid": true,
            "isValid": true,
            "taxRegistrationNumberNormalized": "1111111111",
            "validationInfo": "TAX_NUMBER_SYNTAX_VALID"
          }
        }
      ]
    },
    "deliveryTerm": "SUP",
    "documentDate": "2025-11-06",
    "lineItems": [
      {
        "customer": {
          "destination": {
            "country": "Poland",
            "taxAreaId": "806160000"
          },
          "taxRegistrations": [
            {
              "isoCountryCode": "PL",
              "taxRegistrationNumber": "PL1111111111",
              "validationResult": {
                "isSyntaxValid": true,
                "isValid": true,
                "taxRegistrationNumberNormalized": "1111111111",
                "validationInfo": "TAX_NUMBER_SYNTAX_VALID"
              }
            }
          ]
        },
        "deliveryTerm": "SUP",
        "extendedPrice": 100,
        "fairMarketValue": 100,
        "quantity": {
          "value": 1
        },
        "seller": {
          "company": "seller_1",
          "physicalOrigin": {
            "country": "Germany",
            "taxAreaId": "802760000"
          },
          "taxRegistrations": [
            {
              "isoCountryCode": "PL",
              "jurisdictionId": "0",
              "taxRegistrationNumber": "PL00001"
            }
          ]
        },
        "taxIncludedIndicator": false,
        "taxes": [
          {
            "calculatedTax": 0,
            "effectiveRate": 0,
            "exempt": 0,
            "invoiceTextCodes": [
              16,
              27
            ],
            "isService": false,
            "jurisdiction": {
              "effectiveDate": "1900-01-01",
              "expirationDate": "9999-12-31",
              "jurisdictionId": "78283",
              "jurisdictionType": "COUNTRY",
              "value": "GERMANY"
            },
            "maxTaxIndicator": false,
            "nonTaxable": 0,
            "notRegisteredIndicator": false,
            "situs": "PHYSICAL_ORIGIN",
            "taxCollectedFromParty": "BUYER",
            "taxRateReductionExempt": 0,
            "taxResult": "NO_TAX",
            "taxType": "NONE",
            "taxable": 0
          },
          {
            "calculatedTax": 23,
            "calculationRuleId": {
              "salesTaxHolidayIndicator": false,
              "userDefined": false,
              "value": "v301086010"
            },
            "effectiveRate": 0.23,
            "exempt": 0,
            "imposition": {
              "impositionId": "1",
              "jurisdictionId": "78327",
              "userDefined": false,
              "value": "VAT"
            },
            "impositionType": {
              "impositionTypeId": "v19",
              "informationOnly": false,
              "userDefined": false,
              "value": "VAT"
            },
            "inputOutputType": "OUTPUT",
            "invoiceTextCodes": [
              2,
              27
            ],
            "isService": false,
            "jurisdiction": {
              "effectiveDate": "1900-01-01",
              "expirationDate": "9999-12-31",
              "jurisdictionId": "78327",
              "jurisdictionType": "COUNTRY",
              "value": "POLAND"
            },
            "maxTaxIndicator": false,
            "nominalRate": 0.23,
            "nonTaxable": 0,
            "notRegisteredIndicator": false,
            "postCalculationEvaluationRuleId": {
              "salesTaxHolidayIndicator": false,
              "userDefined": false,
              "value": "v318456382"
            },
            "rateClassification": "Standard Rate",
            "sellerRegistrationId": "PL00001",
            "situs": "DESTINATION",
            "taxCollectedFromParty": "BUYER",
            "taxLiabilityOwner": "SELLER",
            "taxLiabilityRule": "physical-shipment-inside-EU-b2b-intra-community",
            "taxRateReductionExempt": 0,
            "taxResult": "TAXABLE",
            "taxStructure": "SINGLE_RATE",
            "taxType": "VAT",
            "taxable": 100
          }
        ],
        "totalTax": 23,
        "transactionType": "SALE"
      }
    ],
    "returnAssistedParametersIndicator": true,
    "roundAtLineLevel": false,
    "saleMessageType": "QUOTATION",
    "seller": {
      "company": "seller_1",
      "physicalOrigin": {
        "country": "Germany",
        "taxAreaId": "802760000"
      },
      "taxRegistrations": [
        {
          "isoCountryCode": "PL",
          "jurisdictionId": "0",
          "taxRegistrationNumber": "PL00001"
        }
      ]
    },
    "subTotal": 100,
    "total": 123,
    "totalTax": 23,
    "transactionType": "SALE"
  },
  "meta": {
    "app": "vertex-ws.war v9.0.21.0.197",
    "extension": "oseries-plus 0.0.0-SNAPSHOT",
    "timeElapsed(ms)": 8,
    "timeReceived": "2025-11-06T11:36:31.37Z"
  }
}

Swiss Tax ID

This example shows how a Swiss Tax ID can be validated.

Request

{
    "saleMessageType": "QUOTATION",
    "deliveryTerm": "SUP",
    "customer": {
        "customerCode": {
            "value": "customer1"
        },
        "customerName": "Swiss Chocolates",
        "destination": {
            "country": "CH"
        },
        "taxRegistrations": [
            {
                "isoCountryCode": "CH",
                "taxRegistrationNumber": "CHE123.245.678",
                "taxRegistrationType": "VAT Registration"
            }
        ]
    },
    "lineItems": [
        {
            "extendedPrice": 100,
            "taxIncludedIndicator": false
        }
    ],
    "seller": {
        "company": "seller1",
        "physicalOrigin": {
            "country": "PL"
        }
    },
    "transactionType": "SALE"
}

Response

{
    "data": {
        "customer": {
            "customerCode": {
                "isBusinessIndicator": true,
                "value": "customer1"
            },
            "customerName": "Swiss Chocolates",
            "destination": {
                "country": "CH",
                "taxAreaId": "807560000"
            },
            "isTaxExempt": false,
            "taxRegistrations": [
                {
                    "isoCountryCode": "CH",
                    "taxRegistrationNumber": "CHCHE-116.294.121",
                    "taxRegistrationType": "VAT Registration",
                    "validationResult": {
                        "cacheTimestamp": "2025-07-23T09:35:34.4650Z",
                        "cached": true,
                        "isSyntaxValid": true,
                        "isValid": true,
                        "name": "Swiss Chocolates",
                        "taxNumberService": "uid.admin.ch",
                        "taxRegistrationNumberNormalized": "CHE123.245.678",
                        "validationInfo": "TAX_NUMBER_VALID_ACCORDING_TO_EXTERNAL_SERVICE"
                    }
                }
            ]
        },
        "deliveryTerm": "SUP",
        "documentDate": "2025-07-23",
        "lineItems": [
            {
                "customer": {
                    "customerCode": {
                        "isBusinessIndicator": true,
                        "value": "customer1"
                    },
                    "customerName": "Swiss Chocolates",
                    "destination": {
                        "country": "CH",
                        "taxAreaId": "807560000"
                    },
                    "isTaxExempt": false,
                    "taxRegistrations": [
                        {
                            "isoCountryCode": "CH",
                            "taxRegistrationNumber": "CHE123.245.678",
                            "taxRegistrationType": "VAT Registration",
                            "validationResult": {
                                "cacheTimestamp": "2025-07-23T09:35:34.4650Z",
                                "cached": true,
                                "isSyntaxValid": true,
                                "isValid": true,
                                "name": "Swiss Chocolates",
                                "taxNumberService": "uid.admin.ch",
                                "taxRegistrationNumberNormalized": "CHE123.245.678",
                                "validationInfo": "TAX_NUMBER_VALID_ACCORDING_TO_EXTERNAL_SERVICE"
                            }
                        }
                    ]
                },
                "deliveryTerm": "SUP",
                "extendedPrice": 100.0,
                "fairMarketValue": 100.0,
                "quantity": {
                    "value": 1.0
                },
                "seller": {
                    "company": "seller1",
                    "physicalOrigin": {
                        "country": "PL",
                        "taxAreaId": "806160000"
                    },
                    "taxRegistrations": []
                },
                "taxIncludedIndicator": false,
                "taxes": [
                    {
                        "calculatedTax": 0.0,
                        "effectiveRate": 0.0,
                        "exempt": 0.0,
                        "invoiceTextCodes": [
                            1,
                            16
                        ],
                        "isService": false,
                        "jurisdiction": {
                            "effectiveDate": "1900-01-01",
                            "expirationDate": "9999-12-31",
                            "jurisdictionId": "78327",
                            "jurisdictionType": "COUNTRY",
                            "value": "POLAND"
                        },
                        "maxTaxIndicator": false,
                        "nonTaxable": 0.0,
                        "notRegisteredIndicator": false,
                        "situs": "PHYSICAL_ORIGIN",
                        "taxCollectedFromParty": "BUYER",
                        "taxRateReductionExempt": 0.0,
                        "taxResult": "NO_TAX",
                        "taxType": "NONE",
                        "taxable": 0.0
                    },
                    {
                        "buyerRegistrationId": "CHE123.245.678",
                        "calculatedTax": 8.1,
                        "calculationRuleId": {
                            "salesTaxHolidayIndicator": false,
                            "userDefined": false,
                            "value": "v315211496"
                        },
                        "effectiveRate": 0.081,
                        "exempt": 0.0,
                        "imposition": {
                            "impositionId": "1",
                            "jurisdictionId": "78294",
                            "userDefined": false,
                            "value": "VAT"
                        },
                        "impositionType": {
                            "impositionTypeId": "v19",
                            "userDefined": false,
                            "value": "VAT"
                        },
                        "inputOutputType": "OUTPUT",
                        "invoiceTextCodes": [
                            9,
                            21
                        ],
                        "isService": false,
                        "jurisdiction": {
                            "effectiveDate": "1900-01-01",
                            "expirationDate": "9999-12-31",
                            "jurisdictionId": "78294",
                            "jurisdictionType": "COUNTRY",
                            "value": "SWITZERLAND"
                        },
                        "maxTaxIndicator": false,
                        "nominalRate": 0.081,
                        "nonTaxable": 0.0,
                        "notRegisteredIndicator": false,
                        "rateClassification": "Standard Rate",
                        "situs": "DESTINATION",
                        "taxCollectedFromParty": "BUYER",
                        "taxRateReductionExempt": 0.0,
                        "taxResult": "TAXABLE",
                        "taxStructure": "SINGLE_RATE",
                        "taxType": "VAT",
                        "taxable": 100.0
                    }
                ],
                "totalTax": 8.1,
                "transactionType": "SALE"
            }
        ],
        "returnAssistedParametersIndicator": true,
        "roundAtLineLevel": false,
        "saleMessageType": "QUOTATION",
        "seller": {
            "company": "seller1",
            "physicalOrigin": {
                "country": "PL",
                "taxAreaId": "806160000"
            },
            "taxRegistrations": []
        },
        "subTotal": 100.0,
        "total": 108.1,
        "totalTax": 8.1,
        "transactionType": "SALE"
    },
    "meta": {
        "app": "{app ID}",
        "extension": "{extension ID}",
        "timeElapsed(ms)": 15,
        "timeReceived": "2025-07-23T12:00:09.446Z"
    }
}
 

Domestic Tax ID

This example shows checking a domestic Tax ID.

Request

{
    "saleMessageType": "QUOTATION",
    "deliveryTerm": "SUP",
    "customer": {
        "customerCode": {
            "value": "customer1"
        },
        "destination": {
            "country": "Poland"
        },
        "taxRegistrations": [
            {
                "isoCountryCode": "PL",
                "taxRegistrationNumber": "PL774-00-01-451",
                "taxRegistrationType": "VAT Registration"
            }
        ]
    },
    "lineItems": [
        {
            "extendedPrice": 100,
            "seller": {
                "company": "seller1",
                "physicalOrigin": {
                    "country": "PL"
                }
            }
        }
    ],
    "transactionType": "SALE"
}

Response

{
    "data": {
        "customer": {
            "customerCode": {
                "isBusinessIndicator": true,
                "value": "customer1"
            },
            "destination": {
                "country": "Poland",
                "taxAreaId": "806160000"
            },
            "isTaxExempt": false,
            "taxRegistrations": [
                {
                    "isoCountryCode": "PL",
                    "taxRegistrationNumber": "PL774-00-01-451",
                    "taxRegistrationType": "VAT Registration",
                    "validationResult": {
                        "isSyntaxValid": true,
                        "isValid": true,
                        "taxRegistrationNumberNormalized": "7740001451",
                        "validationInfo": "TAX_NUMBER_CONSIDERED_VALID_IN_DOMESTIC_COUNTRY"
                    }
                }
            ]
        },
        "deliveryTerm": "SUP",
        "documentDate": "2025-07-23",
        "lineItems": [
            {
                "customer": {
                    "customerCode": {
                        "isBusinessIndicator": true,
                        "value": "customer1"
                    },
                    "destination": {
                        "country": "Poland",
                        "taxAreaId": "806160000"
                    },
                    "isTaxExempt": false,
                    "taxRegistrations": [
                        {
                            "isoCountryCode": "PL",
                            "taxRegistrationNumber": "PL774-00-01-451",
                            "taxRegistrationType": "VAT Registration",
                            "validationResult": {
                                "isSyntaxValid": true,
                                "isValid": true,
                                "taxRegistrationNumberNormalized": "7740001451",
                                "validationInfo": "TAX_NUMBER_CONSIDERED_VALID_IN_DOMESTIC_COUNTRY"
                            }
                        }
                    ]
                },
                "deliveryTerm": "SUP",
                "extendedPrice": 100.0,
                "fairMarketValue": 100.0,
                "quantity": {
                    "value": 1.0
                },
                "seller": {
                    "company": "seller1",
                    "physicalOrigin": {
                        "country": "PL",
                        "taxAreaId": "806160000"
                    },
                    "taxRegistrations": []
                },
                "taxIncludedIndicator": false,
                "taxes": [
                    {
                        "buyerRegistrationId": "PL774-00-01-451",
                        "calculatedTax": 23.0,
                        "calculationRuleId": {
                            "salesTaxHolidayIndicator": false,
                            "userDefined": false,
                            "value": "v301086010"
                        },
                        "effectiveRate": 0.23,
                        "exempt": 0.0,
                        "imposition": {
                            "impositionId": "1",
                            "jurisdictionId": "78327",
                            "userDefined": false,
                            "value": "VAT"
                        },
                        "impositionType": {
                            "impositionTypeId": "v19",
                            "userDefined": false,
                            "value": "VAT"
                        },
                        "inputOutputType": "OUTPUT",
                        "invoiceTextCodes": [
                            18,
                            21
                        ],
                        "isService": false,
                        "jurisdiction": {
                            "effectiveDate": "1900-01-01",
                            "expirationDate": "9999-12-31",
                            "jurisdictionId": "78327",
                            "jurisdictionType": "COUNTRY",
                            "value": "POLAND"
                        },
                        "maxTaxIndicator": false,
                        "nominalRate": 0.23,
                        "nonTaxable": 0.0,
                        "notRegisteredIndicator": false,
                        "postCalculationEvaluationRuleId": {
                            "salesTaxHolidayIndicator": false,
                            "userDefined": false,
                            "value": "v318456382"
                        },
                        "rateClassification": "Standard Rate",
                        "situs": "DESTINATION",
                        "taxCollectedFromParty": "BUYER",
                        "taxLiabilityOwner": "SELLER",
                        "taxLiabilityRule": "physical-shipment-inside-EU-b2b-domestic",
                        "taxRateReductionExempt": 0.0,
                        "taxResult": "TAXABLE",
                        "taxStructure": "SINGLE_RATE",
                        "taxType": "VAT",
                        "taxable": 100.0
                    }
                ],
                "totalTax": 23.0,
                "transactionType": "SALE"
            }
        ],
        "returnAssistedParametersIndicator": true,
        "roundAtLineLevel": false,
        "saleMessageType": "QUOTATION",
        "subTotal": 100.0,
        "total": 123.0,
        "totalTax": 23.0,
        "transactionType": "SALE"
    },
    "meta": {
        "app": "vertex-ws.war v9.0.20.1.25",
        "extension": "oseries-plus 20250723095736-9b25506a74da7a403dc802e3b48c920b202ace1e",
        "timeElapsed(ms)": 9,
        "timeReceived": "2025-07-23T12:01:04.014Z"
    }
}

Multiple Tax IDs and registration types

This example shows how to validate multiple Tax IDs and multiple registration types.

Request

{
    "saleMessageType": "QUOTATION",
    "deliveryTerm": "SUP",
    "customer": {
        "customerCode": {
            "value": "customer1"
        },
        "customerName": "Swatch",
        "destination": {
            "country": "CH"
        },
        "taxRegistrations": [
            {
                "isoCountryCode": "GB",
                "taxRegistrationNumber": "XI726490424"
            },
            {
                "isoCountryCode": "CH",
                "taxRegistrationNumber": "CHCHE-101.374.515",
                "taxRegistrationType": "VAT Registration"
            },
            {
                "isoCountryCode": "PL",
                "taxRegistrationNumber": "will-not-be-validated",
                "taxRegistrationType": "VAT Registration",
                "validationResult": {
                    "isValid": true
                }
            }
        ]
    },
    "lineItems": [
        {
            "extendedPrice": 100,
            "taxIncludedIndicator": false
        }
    ],
    "seller": {
        "company": "seller1",
        "physicalOrigin": {
            "country": "PL"
        }
    },
    "transactionType": "SALE"
}
 

Response

            "taxRegistrations": [
                {
                    "isoCountryCode": "GB",
                    "taxRegistrationNumber": "XI726490424",
                    "validationResult": {
                        "address": "10 MAYS MEADOW\nBELFAST\n\n\n\nBT1 3PH",
                        "cacheTimestamp": "2025-10-26T02:37:14.4890Z",
                        "cached": true,
                        "isSyntaxValid": true,
                        "isValid": true,
                        "name": "ALLSTATE NORTHERN IRELAND LIMITED",
                        "taxNumberService": "vies",
                        "taxRegistrationNumberNormalized": "726490424",
                        "validationInfo": "TAX_NUMBER_VALID_ACCORDING_TO_EXTERNAL_SERVICE"
                    }
                },
                {
                    "isoCountryCode": "CH",
                    "taxRegistrationNumber": "CHCHE-101.374.515",
                    "taxRegistrationType": "VAT Registration",
                    "validationResult": {
                        "cacheTimestamp": "2025-10-29T18:03:36.1430Z",
                        "cached": true,
                        "isSyntaxValid": true,
                        "isValid": true,
                        "name": "The Swatch Group AG",
                        "taxNumberService": "uid.admin.ch",
                        "taxRegistrationNumberNormalized": "CHE101.374.515",
                        "validationInfo": "TAX_NUMBER_VALID_ACCORDING_TO_EXTERNAL_SERVICE"
                    }
                },
                {
                    "isoCountryCode": "PL",
                    "taxRegistrationNumber": "will-not-be-validated",
                    "taxRegistrationType": "VAT Registration",
                    "validationResult": {
                        "isValid": true
                    }
                }
            ]