Returned Tax Information
Read about the tax information returned by the service.
The service returns information about tax and liability in the API responses. These responses can be individualized for different taxes like VAT or GST. The information can also vary depending on your settings.
Some of the more prominent fields are mentioned in the following table. These are returned for each transaction line:
| Field | Description |
|---|---|
tax_amount | Specifies the amount of tax that is due for the transaction. |
tax_rule_applied | The name of the rule applied by the tax engine. |
tax_liability_owner_code | This code signifies the party who owns the liability. |
tax_supported | This indicates if tax calculation is supported for this transaction. |
A full list of the fields that are returned by the service, is provided in the Taxes Object Fields topic.
Taxed transactions
The following example shows a response to a Confirm Transaction request for a taxed transaction:
{
"transaction": {
"ship_to_address": {
"city": "Big city",
"country_code": "GB",
"postal_code": "00000",
"street_name": "Street name",
"address_detail": "2nd fl",
"building_number": "100a",
"tax_region": "GB"
},
"description": "Transaction description",
"amount": 200,
"required_fields": {
"tax_required_fields": [],
"storage_required_fields": []
},
"marketplace_code": "V4EDemo",
"tax_country_codes": "GB",
"key": "PSqiwAQAAPJFqz_jLCgzo6VMqW1xn5klQ9goY6w",
"tax_amount": 40,
"update_date": "2025-03-28",
"external_unique_id": null,
"invoice_timestamp": "2025-03-01T12:00:00Z",
"confirm_timestamp": "2025-03-28T07:06:07Z",
"tax_liability_owner_codes": "",
"create_timestamp": "2025-03-28T07:01:36Z",
"transaction_lines": [
{
"description": "Product 1",
"reverse_charge": false,
"amount": 100.00,
"tax_engine_additional_parameters": [
{
"param": "FLEX.output.FlexCode25",
"value": "OSC-AK-TEST"
}
],
"tax_rule_applied": "physical-tax",
"unit_price": 100.00,
"taxes": [
{
"tax_type": "VAT",
"imposition_type": "VAT",
"tax_jurisdiction_code": "78295",
"tax_amount": 20.0,
"tax_calculation_rule_id": "v301086121",
"exempt_amount": 0.0,
"tax_base_amount": 100,
"tax_jurisdiction_type": "COUNTRY",
"rate": 20,
"taxable_amount": 100.0,
"tax_authority_name": "UNITED KINGDOM",
"rate_type": "Standard",
"tax_authority_id": "78295",
"tax_name": "VAT physical",
"non_taxable_amount": 0.0,
"imposition": "VAT",
"amount_fraction_taxable": 1
}
],
"tax_amount": 20.00,
"seller_tax_number": "GB123456789",
"tax_region": "GB",
"invoice_place": "Postal address line 1, Postal address line 2, Postal address line 3",
"invoice_number": "GB2025-1",
"tax_exempt": false,
"additional_currencies": {
"invoice": {
"amount": 82.59,
"currency_code": "GBP",
"fx_date": "2025-02-28T12:00:00Z",
"fx_rate": 0.825900231252,
"fx_source": "source_bankofengland",
"total_amount": 99.11,
"tax_amount": 16.52
}
},
"tax_country_code": "GB",
"line_key": "UwJ85ua2PYVf48bX",
"custom_id": "",
"first_line_with_same_designator_index": 0,
"tax_address_kind": "ship_to_address",
"ship_from_address": {
"country_code": "GB",
"tax_region": "GB"
},
"tax_engine": "oseries",
"invoice_status": "R",
"kind": "b2c",
"product_tax_code": {
"class": "TPP/Goods"
},
"invoice_image_url": "(URL)",
"tax_number_service": "tax.service.gov.uk",
"product_class": "P",
"custom_rules_applied": [],
"line_num": 1,
"is_seller_permanent": true,
"quantity": 1.000000000000,
"invoice_capable": true,
"total_amount": 120.00,
"seller_code": "V4EDemo_Seller3",
"invoice_image_url_secret": "id4-IlvR2vU4GMn7",
"tax_entity_name": "United Kingdom",
"tax_supported": true
},
{
"description": "Shipping",
"reverse_charge": false,
"amount": 100.00,
"tax_rule_applied": "physical-tax",
"unit_price": 100.00,
"taxes": [
{
"tax_type": "VAT",
"imposition_type": "VAT",
"tax_jurisdiction_code": "78295",
"tax_amount": 20.00,
"tax_calculation_rule_id": "v301086121",
"exempt_amount": 0.0,
"tax_base_amount": 100.00,
"tax_jurisdiction_type": "COUNTRY",
"rate": 20,
"taxable_amount": 100.0,
"tax_authority_name": "UNITED KINGDOM",
"rate_type": "Standard",
"tax_authority_id": "78295",
"tax_name": "VAT physical",
"non_taxable_amount": 0.0,
"imposition": "VAT",
"amount_fraction_taxable": 1
}
],
"tax_amount": 20.00,
"seller_tax_number": "GB123456789",
"tax_region": "GB",
"invoice_place": "Postal address line 1, Postal address line 2, Postal address line 3",
"invoice_number": "GB2025-1",
"additional_currencies": {
"invoice": {
"amount": 82.59,
"currency_code": "GBP",
"fx_date": "2025-02-28T12:00:00Z",
"fx_rate": 0.825900231252,
"fx_source": "source_bankofengland",
"total_amount": 99.11,
"tax_amount": 16.52
}
},
"tax_country_code": "GB",
"line_key": "bjjMpRAXWINsH9uZ",
"custom_id": "",
"first_line_with_same_designator_index": 0,
"tax_address_kind": "ship_to_address",
"ship_from_address": {
"country_code": "GB",
"tax_region": "GB"
},
"tax_engine": "oseries",
"invoice_status": "R",
"kind": "b2c",
"invoice_image_url": "(URL)",
"tax_number_service": "tax.service.gov.uk",
"product_class": "S",
"custom_rules_applied": [],
"line_num": 2,
"is_seller_permanent": true,
"quantity": 1.000000000000,
"invoice_capable": true,
"total_amount": 120.00,
"seller_code": "V4EDemo_Seller3",
"invoice_image_url_secret": "id4-IlvR2vU4GMn7",
"tax_entity_name": "United Kingdom",
"tax_supported": true
}
],
"rev": 2,
"discounts": [],
"product_classes": "SP",
"billing_address": {
"city": "The big city",
"country_code": "GB",
"postal_code": "00000",
"street_name": "The street name",
"building_number": "100a",
"tax_region": "GB"
},
"status": "C",
"update_timestamp": "2025-03-28T07:01:36Z",
"buyer_name": "Test buyer",
"tax_timestamp": "2025-03-01T12:00:00Z",
"total_amount": 240,
"invoice_image_url_secret": "id4-IlvR2vU4GMn7",
"currency_code": "EUR"
}
}
Untaxed transactions
Transactions were no tax is charged can be created in a number of ways:
- If an entity such as a seller or country is not enabled in the settings.
- The goods are exempt from tax.
Updated about 1 month ago