Skip to main content

Tax component field mapping for Vertex advantage tax

Zuora

Tax component field mapping for Vertex advantage tax

This document outlines the support for Vertex advantage tax_component field mapping, facilitating flexible access to relevant data within billing responses.

The consolidated tax components for the Vertex advantage tax app feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at Zuora Global Support.

Tax calculation call

In a typical tax calculation response from Vertex advantage tax, the tax_component field appears as follows:


        "transaction_lines": [
            {
                "description": "Live - Monthly",
                "amount": 39.0,
                "unit_price": 39.0,
                "custom_fields": [
                    {
                        "key": "invoiceItemId",
                        "value": "8a28b56b8e554f76018e55f3cbaa3030"
                    },
                    {
                        "key": "taxCode",
                        "value": "VAT/GST"
                    },
                    {
                        "key": "taxMode",
                        "value": "0"
                    },
                    {
                        "key": "dbId",
                        "value": "50715533"
                    },
                    {
                        "key": "chargeId",
                        "value": "8a28828d68a2803f0168ab2e14ae1d2d"
                    },
                    {
                        "key": "documentId",
                        "value": "8a28b56b8e554f76018e55f3cb8c302c"
                    },
                    {
                        "key": "documentNumber",
                        "value": "INV01827680"
                    },
                    {
                        "key": "discountAmount",
                        "value": "0"
                    }
                ],
                "tax_amount": 2.57,
                "tax_deducted": false,
                "tax_region": "US",
                "cached_rate": false,
                "tax_rate": 6.5897435898,
                "additional_currencies": {
                    "tax": {
                        "amount": 39.0,
                        "tax_amount": 2.57,
                        "total_amount": 41.57
                    }
                },
                "tax_country_code": "US",
                "line_key": "YIOeJbRhNhOhm1FU",
                "custom_id": "8a28b56b8e554f76018e55f3cbaa3030",
                "tax_name": "Texas Tax",
                "tax_rate_checks": [
                    "CA-GST-enabled",
                    "CA-BC-PST-enabled",
                    "CA-SK-PST-enabled",
                    "CA-QC-QST-enabled"
                ],
                "product_tax_code": "310104",
                "line_num": 1,
                "quantity": 1,
                "total_amount": 41.57,
                "tax_components": [
                    {
                        "revenue": 39.0,
                        "tax_amount": 1.95,
                        "city": "PLANO",
                        "tax_rate": 6.25,
                        "county": "COLLIN",
                        "tax_authority_name": "TEXAS",
                        "tax_authority_id": "35763",
                        "tax_name": "Sales and Use Tax",
                        "revenue_base": 31.2,
                        "calculated_tax_rate_used": true,
                        "percent_taxable": 0.8,
                        "jurisdiction_code": "35763",
                        "calculated_tax_rate": 5,
                        "state_code": "TX"
                    },
                    {
                        "revenue": 39.0,
                        "tax_amount": 0.31,
                        "city": "PLANO",
                        "tax_rate": 1,
                        "county": "COLLIN",
                        "tax_authority_name": "PLANO",
                        "tax_authority_id": "77891",
                        "tax_name": "Local Sales and Use Tax",
                        "revenue_base": 31.2,
                        "calculated_tax_rate_used": true,
                        "percent_taxable": 0.8,
                        "jurisdiction_code": "77891",
                        "calculated_tax_rate": 0.7948717949,
                        "state_code": "TX"
                    },
                    {
                        "revenue": 39.0,
                        "tax_amount": 0.31,
                        "city": "PLANO",
                        "tax_rate": 1,
                        "county": "COLLIN",
                        "tax_authority_name": "DALLAS METROPOLITAN TRANSIT AUTHORITY",
                        "tax_authority_id": "78120",
                        "tax_name": "Local Sales and Use Tax",
                        "revenue_base": 31.2,
                        "calculated_tax_rate_used": true,
                        "percent_taxable": 0.8,
                        "jurisdiction_code": "78120",
                        "calculated_tax_rate": 0.7948717949,
                        "state_code": "TX"
                    }
                ],
                "tax_entity_name": "US",
                "tax_supported": true
            }
        ]

The feature specifically addresses the transaction_lines field, which is where the system extracts tax-related information. By focusing on this specific group, we simplify the process of parsing for faster tax calculations and billing responses, guaranteeing top-notch performance and precision. 

Billing Response Transformation

Within the TaxApp, the response undergoes transformation where the tax_component is flattened for easier access:

  "transaction_lines":
    [
        {
            "description": "Live - Monthly",
            "amount": 39.0,
            "unit_price": 39.0,
            "custom_fields":
            [
                {
                    "key": "invoiceItemId",
                    "value": "8a28b56b8e554f76018e55f3cbaa3030"
                },
                {
                    "key": "taxCode",
                    "value": "VAT/GST"
                },
                {
                    "key": "taxMode",
                    "value": "0"
                },
                {
                    "key": "dbId",
                    "value": "50715533"
                },
                {
                    "key": "chargeId",
                    "value": "8a28828d68a2803f0168ab2e14ae1d2d"
                },
                {
                    "key": "documentId",
                    "value": "8a28b56b8e554f76018e55f3cb8c302c"
                },
                {
                    "key": "documentNumber",
                    "value": "INV01827680"
                },
                {
                    "key": "discountAmount",
                    "value": "0"
                }
            ],
            "tax_deducted": false,
            "tax_region": "US",
            "cached_rate": false,
            "additional_currencies":
            {
                "tax":
                {
                    "amount": 39.0,
                    "tax_amount": 2.57,
                    "total_amount": 41.57
                }
            },
            "tax_country_code": "US",
            "line_key": "YIOeJbRhNhOhm1FU",
            "custom_id": "8a28b56b8e554f76018e55f3cbaa3030",
            "tax_name": "Sales and Use Tax",
            "tax_rate_checks":
            [
                "CA-GST-enabled",
                "CA-BC-PST-enabled",
                "CA-SK-PST-enabled",
                "CA-QC-QST-enabled"
            ],
            "product_tax_code": "310104",
            "line_num": 1,
            "quantity": 1,
            "total_amount": 41.57,
            "revenue": 39.0,
            "tax_amount": 1.95,
            "city": "PLANO",
            "tax_rate": 6.25,
            "county": "COLLIN",
            "tax_authority_name": "TEXAS",
            "tax_authority_id": "35763",
            "revenue_base": 31.2,
            "calculated_tax_rate_used": true,
            "percent_taxable": 0.8,
            "jurisdiction_code": "35763",
            "calculated_tax_rate": 5,
            "state_code": "TX",
            "tax_entity_name": "US",
            "tax_supported": true
        },
        {
            "description": "Live - Monthly",
            "amount": 39.0,
            "unit_price": 39.0,
            "custom_fields":
            [
                {
                    "key": "invoiceItemId",
                    "value": "8a28b56b8e554f76018e55f3cbaa3030"
                },
                {
                    "key": "taxCode",
                    "value": "VAT/GST"
                },
                {
                    "key": "taxMode",
                    "value": "0"
                },
                {
                    "key": "dbId",
                    "value": "50715533"
                },
                {
                    "key": "chargeId",
                    "value": "8a28828d68a2803f0168ab2e14ae1d2d"
                },
                {
                    "key": "documentId",
                    "value": "8a28b56b8e554f76018e55f3cb8c302c"
                },
                {
                    "key": "documentNumber",
                    "value": "INV01827680"
                },
                {
                    "key": "discountAmount",
                    "value": "0"
                }
            ],
            "tax_deducted": false,
            "tax_region": "US",
            "cached_rate": false,
            "additional_currencies":
            {
                "tax":
                {
                    "amount": 39.0,
                    "tax_amount": 2.57,
                    "total_amount": 41.57
                }
            },
            "tax_country_code": "US",
            "line_key": "YIOeJbRhNhOhm1FU",
            "custom_id": "8a28b56b8e554f76018e55f3cbaa3030",
            "tax_name": "Local Sales and Use Tax",
            "tax_rate_checks":
            [
                "CA-GST-enabled",
                "CA-BC-PST-enabled",
                "CA-SK-PST-enabled",
                "CA-QC-QST-enabled"
            ],
            "product_tax_code": "310104",
            "line_num": 1,
            "quantity": 1,
            "total_amount": 41.57,
            "revenue": 39.0,
            "tax_amount": 0.31,
            "city": "PLANO",
            "tax_rate": 1,
            "county": "COLLIN",
            "tax_authority_name": "PLANO",
            "tax_authority_id": "77891",
            "revenue_base": 31.2,
            "calculated_tax_rate_used": true,
            "percent_taxable": 0.8,
            "jurisdiction_code": "77891",
            "calculated_tax_rate": 0.7948717949,
            "state_code": "TX",
            "tax_entity_name": "US",
            "tax_supported": true
        },
        {
            "description": "Live - Monthly",
            "amount": 39.0,
            "unit_price": 39.0,
            "custom_fields":
            [
                {
                    "key": "invoiceItemId",
                    "value": "8a28b56b8e554f76018e55f3cbaa3030"
                },
                {
                    "key": "taxCode",
                    "value": "VAT/GST"
                },
                {
                    "key": "taxMode",
                    "value": "0"
                },
                {
                    "key": "dbId",
                    "value": "50715533"
                },
                {
                    "key": "chargeId",
                    "value": "8a28828d68a2803f0168ab2e14ae1d2d"
                },
                {
                    "key": "documentId",
                    "value": "8a28b56b8e554f76018e55f3cb8c302c"
                },
                {
                    "key": "documentNumber",
                    "value": "INV01827680"
                },
                {
                    "key": "discountAmount",
                    "value": "0"
                }
            ],
            "tax_deducted": false,
            "tax_region": "US",
            "cached_rate": false,
            "additional_currencies":
            {
                "tax":
                {
                    "amount": 39.0,
                    "tax_amount": 2.57,
                    "total_amount": 41.57
                }
            },
            "tax_country_code": "US",
            "line_key": "YIOeJbRhNhOhm1FU",
            "custom_id": "8a28b56b8e554f76018e55f3cbaa3030",
            "tax_name": "Sales and Use Tax",
            "tax_rate_checks":
            [
                "CA-GST-enabled",
                "CA-BC-PST-enabled",
                "CA-SK-PST-enabled",
                "CA-QC-QST-enabled"
            ],
            "product_tax_code": "310104",
            "line_num": 1,
            "quantity": 1,
            "total_amount": 41.57,
            "revenue": 39.0,
            "tax_amount": 1.95,
            "city": "PLANO",
            "tax_rate": 6.25,
            "county": "COLLIN",
            "tax_authority_name": "TEXAS",
            "tax_authority_id": "35763",
            "revenue_base": 31.2,
            "calculated_tax_rate_used": true,
            "percent_taxable": 0.8,
            "jurisdiction_code": "35763",
            "calculated_tax_rate": 5,
            "state_code": "TX",
            "tax_entity_name": "US",
            "tax_supported": true
        }
    ]

 Due to the flattening of tax_components within the transaction fields, accessing them for flexible field mapping becomes straightforward. Direct access eliminates the need for nested structures, simplifying data retrieval and enhancing the efficiency of our system's field mapping process.

Below is a screenshot demonstrating the ease of accessing these fields:

fieldmapping.png

Refund call (credit memo) response

In the refund response, the structure of the tax components is flattened to facilitate parsing within the TaxApp. Below is an example of the Vertex advantage tax refund response:


{
    "refund_reason": null,
    "amount": 40.0,
    "refund_note_number_expanded": "CN-US2021-60177-1",
    "refunded_amount": 40.0,
    "refund_timestamp": "2024-03-27T22:21:06Z",
    "tax_amount": 4.1,
    "refunded_tax_amount": 4.1,
    "refund_note_number": 1,
    "refunded_total_amount": 44.1,
    "refund_key": "mzhkq3rM5qJ9_Q",
    "total_amount": 44.1,
    "refunds":
    [
        {
            "refund_reason": null,
            "amount": 40.0,
            "informative": null,
            "refund_note_number_expanded": "CN-US2021-60177-1",
            "refunded_amount": 40.0,
            "refund_timestamp": "2024-03-27T22:21:06Z",
            "tax_amount": 4.1,
            "refund_note_url": "https://invoice.taxamo.com/api/v1/transactions/TBIQAAEbMGy8KD60ELSJmBJvRWX8/invoice/refunds/1/preview",
            "tax_rate": 10.25,
            "line_key": "RuR2s90BnS6CWSfe",
            "custom_id": "8a90cb5d8e7fe1ac018e820095e53766",
            "refunded_tax_amount": 4.1,
            "refund_note_number": 1,
            "refunded_total_amount": 44.1,
            "refund_key": "mzhkq3rM5qJ9_Q",
            "total_amount": 44.1,
            "refund_unique_id": null,
            "tax_components":
            [
                {
                    "revenue": 40.0,
                    "tax_amount": 2.6,
                    "tax_result": "TAXABLE",
                    "city": "SEATTLE",
                    "tax_rate": 6.5,
                    "county": "KING",
                    "tax_authority_name": "WASHINGTON",
                    "refunded_tax_amount": 2.6,
                    "tax_authority_id": "40256",
                    "tax_name": "Retail Sales and Use Tax",
                    "revenue_base": 40.0,
                    "percent_taxable": 1,
                    "jurisdiction_code": "40256",
                    "state_code": "WA",
                    "jurisdiction_type": "STATE"
                },
                {
                    "revenue": 40.0,
                    "tax_amount": 0.0,
                    "tax_result": "NONTAXABLE",
                    "city": "SEATTLE",
                    "tax_rate": 0,
                    "county": "KING",
                    "tax_authority_name": "KING",
                    "refunded_tax_amount": 0.0,
                    "tax_authority_id": "40453",
                    "tax_name": "Local Sales and Use Tax",
                    "revenue_base": 40.0,
                    "calculated_tax_rate_used": true,
                    "percent_taxable": 1,
                    "jurisdiction_code": "40453",
                    "calculated_tax_rate": 0,
                    "state_code": "WA",
                    "jurisdiction_type": "COUNTY"
                },
                {
                    "revenue": 40.0,
                    "tax_amount": 0.88,
                    "tax_result": "TAXABLE",
                    "city": "SEATTLE",
                    "tax_rate": 2.2,
                    "county": "KING",
                    "tax_authority_name": "SEATTLE",
                    "refunded_tax_amount": 0.88,
                    "tax_authority_id": "40463",
                    "tax_name": "Local Sales and Use Tax",
                    "revenue_base": 40.0,
                    "percent_taxable": 1,
                    "jurisdiction_code": "40463",
                    "state_code": "WA",
                    "jurisdiction_type": "CITY"
                },
                {
                    "revenue": 40.0,
                    "tax_amount": 0.56,
                    "tax_result": "TAXABLE",
                    "city": "SEATTLE",
                    "tax_rate": 1.4,
                    "county": "KING",
                    "tax_authority_name": "REGIONAL TRANSIT AUTHORITY",
                    "refunded_tax_amount": 0.56,
                    "tax_authority_id": "102655",
                    "tax_name": "Local Sales and Use Tax",
                    "revenue_base": 40.0,
                    "percent_taxable": 1,
                    "jurisdiction_code": "102655",
                    "state_code": "WA",
                    "jurisdiction_type": "DISTRICT"
                },
                {
                    "revenue": 40.0,
                    "tax_amount": 0.06,
                    "tax_result": "TAXABLE",
                    "city": "SEATTLE",
                    "tax_rate": 0.15,
                    "county": "KING",
                    "tax_authority_name": "SEATTLE TRANSPORTATION BENEFIT DISTRICT",
                    "refunded_tax_amount": 0.06,
                    "tax_authority_id": "106008",
                    "tax_name": "Local Sales and Use Tax",
                    "revenue_base": 40.0,
                    "percent_taxable": 1,
                    "jurisdiction_code": "106008",
                    "state_code": "WA",
                    "jurisdiction_type": "DISTRICT"
                }
            ]
        }
    ]
}

TaxApp response parsing

When processing the refund response within the TaxApp, the original structure is transformed to facilitate efficient parsing. Specifically, the tax components are flattened for easier integration with TaxApp functionalities. Below is an excerpt of the transformed response, focusing solely on the refund fields:

   "refunds":
    [
        {
            "refund_reason": null,
            "amount": 40.0,
            "informative": null,
            "refund_note_number_expanded": "CN-US2021-60177-1",
            "refunded_amount": 40.0,
            "refund_timestamp": "2024-03-27T22:21:06Z",
            "refund_note_url": "https://invoice.taxamo.com/api/v1/transactions/TBIQAAEbMGy8KD60ELSJmBJvRWX8/invoice/refunds/1/preview",
            "line_key": "RuR2s90BnS6CWSfe",
            "custom_id": "8a90cb5d8e7fe1ac018e820095e53766",
            "refund_note_number": 1,
            "refunded_total_amount": 44.1,
            "refund_key": "mzhkq3rM5qJ9_Q",
            "total_amount": 44.1,
            "refund_unique_id": null,
            "revenue": 40.0,
            "tax_amount": 2.6,
            "tax_result": "TAXABLE",
            "city": "SEATTLE",
            "tax_rate": 6.5,
            "county": "KING",
            "tax_authority_name": "WASHINGTON",
            "refunded_tax_amount": 2.6,
            "tax_authority_id": "40256",
            "tax_name": "Retail Sales and Use Tax",
            "revenue_base": 40.0,
            "percent_taxable": 1,
            "jurisdiction_code": "40256",
            "state_code": "WA",
            "jurisdiction_type": "STATE"
        },
        {
            "refund_reason": null,
            "amount": 40.0,
            "informative": null,
            "refund_note_number_expanded": "CN-US2021-60177-1",
            "refunded_amount": 40.0,
            "refund_timestamp": "2024-03-27T22:21:06Z",
            "refund_note_url": "https://invoice.taxamo.com/api/v1/transactions/TBIQAAEbMGy8KD60ELSJmBJvRWX8/invoice/refunds/1/preview",
            "line_key": "RuR2s90BnS6CWSfe",
            "custom_id": "8a90cb5d8e7fe1ac018e820095e53766",
            "refund_note_number": 1,
            "refunded_total_amount": 44.1,
            "refund_key": "mzhkq3rM5qJ9_Q",
            "total_amount": 44.1,
            "refund_unique_id": null,
            "revenue": 40.0,
            "tax_amount": 0.0,
            "tax_result": "NONTAXABLE",
            "city": "SEATTLE",
            "tax_rate": 0,
            "county": "KING",
            "tax_authority_name": "KING",
            "refunded_tax_amount": 0.0,
            "tax_authority_id": "40453",
            "tax_name": "Local Sales and Use Tax",
            "revenue_base": 40.0,
            "calculated_tax_rate_used": true,
            "percent_taxable": 1,
            "jurisdiction_code": "40453",
            "calculated_tax_rate": 0,
            "state_code": "WA",
            "jurisdiction_type": "COUNTY"
        },
        {
            "refund_reason": null,
            "amount": 40.0,
            "informative": null,
            "refund_note_number_expanded": "CN-US2021-60177-1",
            "refunded_amount": 40.0,
            "refund_timestamp": "2024-03-27T22:21:06Z",
            "refund_note_url": "https://invoice.taxamo.com/api/v1/transactions/TBIQAAEbMGy8KD60ELSJmBJvRWX8/invoice/refunds/1/preview",
            "line_key": "RuR2s90BnS6CWSfe",
            "custom_id": "8a90cb5d8e7fe1ac018e820095e53766",
            "refund_note_number": 1,
            "refunded_total_amount": 44.1,
            "refund_key": "mzhkq3rM5qJ9_Q",
            "total_amount": 44.1,
            "refund_unique_id": null,
            "revenue": 40.0,
            "tax_amount": 0.88,
            "tax_result": "TAXABLE",
            "city": "SEATTLE",
            "tax_rate": 2.2,
            "county": "KING",
            "tax_authority_name": "SEATTLE",
            "refunded_tax_amount": 0.88,
            "tax_authority_id": "40463",
            "tax_name": "Local Sales and Use Tax",
            "revenue_base": 40.0,
            "percent_taxable": 1,
            "jurisdiction_code": "40463",
            "state_code": "WA",
            "jurisdiction_type": "CITY"
        },
        {
            "refund_reason": null,
            "amount": 40.0,
            "informative": null,
            "refund_note_number_expanded": "CN-US2021-60177-1",
            "refunded_amount": 40.0,
            "refund_timestamp": "2024-03-27T22:21:06Z",
            "refund_note_url": "https://invoice.taxamo.com/api/v1/transactions/TBIQAAEbMGy8KD60ELSJmBJvRWX8/invoice/refunds/1/preview",
            "line_key": "RuR2s90BnS6CWSfe",
            "custom_id": "8a90cb5d8e7fe1ac018e820095e53766",
            "refund_note_number": 1,
            "refunded_total_amount": 44.1,
            "refund_key": "mzhkq3rM5qJ9_Q",
            "total_amount": 44.1,
            "refund_unique_id": null,
            "revenue": 40.0,
            "tax_amount": 0.56,
            "tax_result": "TAXABLE",
            "city": "SEATTLE",
            "tax_rate": 1.4,
            "county": "KING",
            "tax_authority_name": "REGIONAL TRANSIT AUTHORITY",
            "refunded_tax_amount": 0.56,
            "tax_authority_id": "102655",
            "tax_name": "Local Sales and Use Tax",
            "revenue_base": 40.0,
            "percent_taxable": 1,
            "jurisdiction_code": "102655",
            "state_code": "WA",
            "jurisdiction_type": "DISTRICT"
        },
        {
            "refund_reason": null,
            "amount": 40.0,
            "informative": null,
            "refund_note_number_expanded": "CN-US2021-60177-1",
            "refunded_amount": 40.0,
            "refund_timestamp": "2024-03-27T22:21:06Z",
            "refund_note_url": "https://invoice.taxamo.com/api/v1/transactions/TBIQAAEbMGy8KD60ELSJmBJvRWX8/invoice/refunds/1/preview",
            "line_key": "RuR2s90BnS6CWSfe",
            "custom_id": "8a90cb5d8e7fe1ac018e820095e53766",
            "refund_note_number": 1,
            "refunded_total_amount": 44.1,
            "refund_key": "mzhkq3rM5qJ9_Q",
            "total_amount": 44.1,
            "refund_unique_id": null,
            "revenue": 40.0,
            "tax_amount": 2.6,
            "tax_result": "TAXABLE",
            "city": "SEATTLE",
            "tax_rate": 6.5,
            "county": "KING",
            "tax_authority_name": "WASHINGTON",
            "refunded_tax_amount": 2.6,
            "tax_authority_id": "40256",
            "tax_name": "Retail Sales and Use Tax",
            "revenue_base": 40.0,
            "percent_taxable": 1,
            "jurisdiction_code": "40256",
            "state_code": "WA",
            "jurisdiction_type": "STATE"
        }
    ]

All fields mentioned above are accessible for field mapping purposes within the TaxApp. This ensures comprehensive integration and mapping of refund data. 

Behavioral changes in billing response

As part of the billing response transformation, the tax component structure has been modified to align with the flattened format observed in the refund response. This restructuring ensures consistency and ease of data handling within the TaxApp.

Before Transformation


{
    "taxationItems": [
        {
            "invoiceItemId": "8ad0828a7ea9de22017eb6c2114b66b3",
            "taxAmount": 3.96,
            "taxAmountUnRounded": 3.96,
            "exemptAmount": 0.0,
            "name": "Texas Tax",
            "jurisdiction": "US",
            "locationCode": "US",
            "taxCode": "AvalaraTelcoCode",
            "taxCodeDescription": "transactionKey=TG0QAAEbMREAKD6Xlt5JmFNNv6ag ; lineKey=zeItNXgS_TLCmQCa",
            "taxDate": "2022-02-01",
            "taxMode": "0",
            "taxRate": 0.066033016508,
            "taxRateType": "Percentage",
            "country": "US"
        }
    ],
    "transactionId": "TG0QAAEbMREAKD6Xlt5JmFNNv6ag"
}

After Transformation 

{
    "taxationItems": [
        {
            "invoiceItemId": "8ad0828a7ea9de22017eb6c2114b66b3",
            "taxAmount": 3.0,
            "taxAmountUnRounded": 3.0,
            "exemptAmount": 0.0,
            "name": "Sales and Use Tax",
            "jurisdiction": "US",
            "locationCode": "US",
            "taxCode": "AvalaraTelcoCode",
            "taxCodeDescription": "transactionKey=TXtIAAEbMmYgKD6qjdvxmFNOpv_c ; lineKey=ynmtZ3s_oLV2hKJe",
            "taxDate": "2022-02-01",
            "taxMode": "0",
            "taxRate": 0.0625,
            "taxRateType": "Percentage",
            "country": "US"
        },
        {
            "invoiceItemId": "8ad0828a7ea9de22017eb6c2114b66b3",
            "taxAmount": 0.48,
            "taxAmountUnRounded": 0.48,
            "exemptAmount": 0.0,
            "name": "Local Sales and Use Tax",
            "jurisdiction": "US",
            "locationCode": "US",
            "taxCode": "AvalaraTelcoCode",
            "taxCodeDescription": "transactionKey=TXtIAAEbMmYgKD6qjdvxmFNOpv_c ; lineKey=ynmtZ3s_oLV2hKJe",
            "taxDate": "2022-02-01",
            "taxMode": "0",
            "taxRate": 0.01,
            "taxRateType": "Percentage",
            "country": "US"
        },
        {
            "invoiceItemId": "8ad0828a7ea9de22017eb6c2114b66b3",
            "taxAmount": 0.48,
            "taxAmountUnRounded": 0.48,
            "exemptAmount": 0.0,
            "name": "Local Sales and Use Tax",
            "jurisdiction": "US",
            "locationCode": "US",
            "taxCode": "AvalaraTelcoCode",
            "taxCodeDescription": "transactionKey=TXtIAAEbMmYgKD6qjdvxmFNOpv_c ; lineKey=ynmtZ3s_oLV2hKJe",
            "taxDate": "2022-02-01",
            "taxMode": "0",
            "taxRate": 0.01,
            "taxRateType": "Percentage",
            "country": "US"
        }
    ],
    "transactionId": "TXtIAAEbMmYgKD6qjdvxmFNOpv_c"
}

Reference Vertex advantage tax response

The transformation is based on the Vertex advantage tax response structure, which includes detailed tax component information. Below is a summarized representation of the Vertex advantage tax response for the corresponding billing transaction:

This alignment facilitates streamlined processing and integration of billing data within the TaxApp, enhancing its functionality and performance.

{
    "transaction":
    {
        "amount": 59.97,
        "invoice_address":
        {
            "city": "Austin",
            "street_name": "4711 YORK HILL DR",
            "address_detail": "4711 YORK HILL DR",
            "country": "US",
            "postal_code": "78723",
            "region": "Texas",
            "lookup_result":
            {
                "found": false
            },
            "tax_area_id": "444530150"
        },
        "buyer_credit_card_prefix": "",
        "custom_fields":
        [
            {
                "key": "request_datetime",
                "value": "2024-04-09-11:05"
            },
            {
                "key": "origin",
                "value": "Zuora"
            },
            {
                "key": "tax_exempt_status",
                "value": ""
            },
            {
                "key": "tax_exempt_certificate_id",
                "value": ""
            },
            {
                "key": "preview_mode",
                "value": "false"
            },
            {
                "key": "event_type",
                "value": "taxGenerate"
            }
        ],
        "tax_country_codes": "US",
        "key": "TXtIAAEbMmYgKD6qjdvxmFNOpv_c",
        "tax_amount": 3.96,
        "buyer_tax_number": "",
        "tax_deducted": false,
        "tax_region": "US",
        "billing_country_code": "US",
        "confirm_timestamp": "2024-04-09T05:35:37Z",
        "merchant_id": 18124,
        "evidence":
        {
            "by_ip":
            {
                "evidence_value": "",
                "evidence_type": "by-ip"
            },
            "by_cc":
            {
                "evidence_value": "",
                "evidence_type": "by-cc"
            },
            "by_tax_number":
            {
                "evidence_value": "",
                "evidence_type": "by-tax-number"
            },
            "by_billing":
            {
                "evidence_value": "US",
                "used": true,
                "resolved_country_code": "US",
                "evidence_type": "by-billing"
            }
        },
        "invoice_place": "Default place for test mode",
        "create_timestamp": "2024-04-09T05:35:37Z",
        "tax_country_code": "US",
        "countries":
        {
            "by_billing":
            {
                "code_long": "USA",
                "name": "United States",
                "cca2": "US",
                "tax_region": "US",
                "codenum": "840",
                "currency":
                [
                    "USD",
                    "USN",
                    "USS"
                ],
                "code": "US",
                "cca3": "USA",
                "callingCode":
                [
                    "1"
                ],
                "tax_supported": true,
                "ccn3": "840"
            },
            "detected":
            {
                "code_long": "USA",
                "name": "United States",
                "cca2": "US",
                "tax_region": "US",
                "codenum": "840",
                "currency":
                [
                    "USD",
                    "USN",
                    "USS"
                ],
                "code": "US",
                "cca3": "USA",
                "callingCode":
                [
                    "1"
                ],
                "tax_supported": true,
                "ccn3": "840"
            }
        },
        "transaction_lines":
        [
            {
                "description": "",
                "amount": 59.97,
                "unit_price": 59.97,
                "custom_fields":
                [
                    {
                        "key": "invoiceItemId",
                        "value": "8ad0828a7ea9de22017eb6c2114b66b3"
                    },
                    {
                        "key": "taxCode",
                        "value": "AvalaraTelcoCode"
                    },
                    {
                        "key": "taxMode",
                        "value": "0"
                    },
                    {
                        "key": "dbId",
                        "value": "210"
                    },
                    {
                        "key": "chargeId",
                        "value": "2c92c0fb7acdac7e017aced35334642e"
                    },
                    {
                        "key": "documentId",
                        "value": "8ad0828a7ea9de22017eb6c210e966ae"
                    },
                    {
                        "key": "documentNumber",
                        "value": "SB13INV00006001"
                    },
                    {
                        "key": "discountAmount",
                        "value": "0"
                    }
                ],
                "tax_amount": 3.96,
                "tax_deducted": false,
                "tax_region": "US",
                "cached_rate": false,
                "tax_rate": 6.6033016508,
                "additional_currencies":
                {
                    "tax":
                    {
                        "amount": 59.97,
                        "tax_amount": 3.96,
                        "total_amount": 63.93
                    }
                },
                "tax_country_code": "US",
                "line_key": "ynmtZ3s_oLV2hKJe",
                "custom_id": "8ad0828a7ea9de22017eb6c2114b66b3",
                "tax_name": "Texas Tax",
                "tax_rate_checks":
                [
                    "CA-BC-PST-enabled",
                    "CA-SK-PST-enabled",
                    "CA-QC-QST-enabled"
                ],
                "product_tax_code": "310104",
                "line_num": 1,
                "quantity": 1,
                "total_amount": 63.93,
                "tax_components":
                [
                    {
                        "revenue": 59.97,
                        "tax_amount": 3.0,
                        "tax_result": "TAXABLE",
                        "city": "AUSTIN",
                        "tax_rate": 6.25,
                        "county": "TRAVIS",
                        "tax_authority_name": "TEXAS",
                        "tax_authority_id": "35763",
                        "tax_name": "Sales and Use Tax",
                        "revenue_base": 47.98,
                        "calculated_tax_rate_used": true,
                        "percent_taxable": 0.8,
                        "jurisdiction_code": "35763",
                        "calculated_tax_rate": 5.0025012506,
                        "state_code": "TX",
                        "jurisdiction_type": "STATE"
                    },
                    {
                        "revenue": 59.97,
                        "tax_amount": 0.48,
                        "tax_result": "TAXABLE",
                        "city": "AUSTIN",
                        "tax_rate": 1,
                        "county": "TRAVIS",
                        "tax_authority_name": "AUSTIN",
                        "tax_authority_id": "77848",
                        "tax_name": "Local Sales and Use Tax",
                        "revenue_base": 47.98,
                        "calculated_tax_rate_used": true,
                        "percent_taxable": 0.8,
                        "jurisdiction_code": "77848",
                        "calculated_tax_rate": 0.8004002001,
                        "state_code": "TX",
                        "jurisdiction_type": "CITY"
                    },
                    {
                        "revenue": 59.97,
                        "tax_amount": 0.48,
                        "tax_result": "TAXABLE",
                        "city": "AUSTIN",
                        "tax_rate": 1,
                        "county": "TRAVIS",
                        "tax_authority_name": "AUSTIN METROPOLITAN TRANSIT AUTHORITY",
                        "tax_authority_id": "78110",
                        "tax_name": "Local Sales and Use Tax",
                        "revenue_base": 47.98,
                        "calculated_tax_rate_used": true,
                        "percent_taxable": 0.8,
                        "jurisdiction_code": "78110",
                        "calculated_tax_rate": 0.8004002001,
                        "state_code": "TX",
                        "jurisdiction_type": "TRANSIT_DISTRICT"
                    }
                ],
                "tax_entity_name": "US",
                "tax_supported": true
            }
        ],
        "buyer_ip": "",
        "custom_id": "SB13INV00006001",
        "manual": false,
        "country_name": "United States",
        "product_classes": "D",
        "fully_informative": false,
        "tax_engine": "oseries",
        "status": "C",
        "kind": "us-b2c",
        "invoice_image_url": "https://invoice.taxamo.com/api/v1/transactions/TXtIAAEbMmYgKD6qjdvxmFNOpv_c/invoice",
        "update_timestamp": 1712640937160,
        "shipment_country_data":
        {},
        "buyer_name": "2c92c0f877448111017745d23b361284",
        "deducted_tax_amount": 0,
        "order_date": "2022-02-01T00:00:00Z",
        "invoice_capable": true,
        "total_amount": 63.93,
        "tax_components":
        [
            {
                "tax_amount": 3.0,
                "city": "AUSTIN",
                "tax_rate": 6.25,
                "county": "TRAVIS",
                "tax_authority_name": "TEXAS",
                "tax_authority_id": "35763",
                "tax_name": "Sales and Use Tax",
                "jurisdiction_code": "35763",
                "state_code": "TX"
            },
            {
                "tax_amount": 0.48,
                "city": "AUSTIN",
                "tax_rate": 1,
                "county": "TRAVIS",
                "tax_authority_name": "AUSTIN",
                "tax_authority_id": "77848",
                "tax_name": "Local Sales and Use Tax",
                "jurisdiction_code": "77848",
                "state_code": "TX"
            },
            {
                "tax_amount": 0.48,
                "city": "AUSTIN",
                "tax_rate": 1,
                "county": "TRAVIS",
                "tax_authority_name": "AUSTIN METROPOLITAN TRANSIT AUTHORITY",
                "tax_authority_id": "78110",
                "tax_name": "Local Sales and Use Tax",
                "jurisdiction_code": "78110",
                "state_code": "TX"
            }
        ],
        "tax_timezone": "GMT",
        "test": true,
        "tax_entity_id": -40001,
        "tax_entity_name": "Texas",
        "tax_supported": true,
        "customer_id": "ACT000000011",
        "tax_location_id": -400001,
        "currency_code": "USD"
    },
    "tax_required_fields":
    [
        {
            "field_name": "invoice_address.postal_code"
        }
    ],
    "storage_required_fields":
    [],
    "is_delegated": false
}