Tax Integration dashboard
Zuora System Health dashboard for Tax Integration (Tax Integration dashboard) collects and displays data about usage, performance, and error of the integration between Zuora and tax vendors in near real time. Through the Tax Integration dashboard, you can view tax integration data from all bill runs, including billing preview runs, in your Zuora tenant within the last 30 days. You can use this dashboard to detect and troubleshoot tax integration issues.
For more information about the System Health feature, see Zuora System Health.
Prerequisites
For the prerequisites of the Tax Integration dashboard, see Zuora System Health prerequisites.
Access the Tax Integration dashboard
To access the Tax Integration dashboard, navigate to Administration > System Health > Tax Integration in the left navigation menu.
Tax Integration metrics
The following table provides descriptions of the Tax Integration metrics.
| Metric | Description |
|---|---|
|
Tax Integration Usage |
The number of tax calls sent to a tax vendor by the configurable tax app within a specified time range, including successful and failed tax calls. When hovering over each time interval bar, you can view the breakdown data of that time range.
|
|
Tax Integration Errors |
The number of failed tax calls within a specified time range. Error means the tax calculation is failed on the configurable tax app side. When hovering over each time interval bar, you can view the breakdown data of that time range. |
|
Tax Integration Performance |
Tax call handling time for a given vendor within a specified time range. Tax call handling time means the sum of the request time and the response time of a tax call.
When hovering over each time interval point, you can view the breakdown data of that time range. Average Tax Transaction Duration: The total handling time divided by the total number of tax calls. |
Note that you can configure notifications based on the Tax Integration Errors metrics. For more information, see Standard events for Zuora Central Platform.
View data in the Tax Integration dashboard
The Tax Integration dashboard is located under the Administration > System Health section in the left navigation menu. It contains a Data Summary section and three tabs that display the usage, error, and performance data related to Tax Integration separately.
- Data Summary section: This section is located at the top of this dashboard, encompassing the following data boxes that display data summaries within the last seven days.
- Total Tax Transaction: This data box displays the total number of successful and failed tax calls sent to a tax vendor within the last seven days and the week-over-week change.
- Total Failures: This data box displays the total number of failed tax calls sent to a tax vendor within the last seven days and the week-over-week change.
- Avg. Tax Transaction Duration: This data box displays the average execution duration (measured in milliseconds) of tax transaction within the last seven days and the week-over-week change.
- Overview tab: This tab displays the data of the Tax Integration Usage metric.
- Failures tab: This tab displays the data of the Tax Integration Errors metric.
- Performance tab: This tab displays the data of the Tax Integration Performance metric.
After you open a tab in the dashboard, you can take the following steps to view the data.
Configure filters
You can customize the data to be displayed by using the filters.
- In the upper right of the dashboard, click the Filters icon.
- Use the Timeframe, Start Time, End Time, Vendor Name, Event Type, and Status fields to specify the data you want to view.
The Vendor Name list displays the tax vendors that your tenant is using by default.
The Event Type list displays different event types including Tax Call, Override Call, Preview Call, and Cancel Call. Specifically, Tax Call indicates tax generation. - Click Apply to apply the filter, or click Reset to go back to the default filter configuration.
View the trend charts
- Select Day, Hour, or Minute as the time interval of the charts in the upper right of the chart.
Note that available interval options vary based on the length of the selected time range. Only the Day Interval is enabled when the range is greater than 60 hours. - When hovering over each bar or point, you can view the breakdown data of that time range, which contains the change percentage compared to the previous interval.
- Use the table below the trend chart to view detailed data within the selected time range.
The detailed tables are available under the Overview and Failures tabs.- By default, the table displays all the items within the specified time range. You can narrow the scope to a specific interval by clicking a bar in the chart. To go back to the global time-range set in the filter, click Reset next to the specific time range displayed above the chart.
- Click the Filter icon in the upper right of the table to list the data that you want to view. When you finish configuring the filter, click Apply. Click Clear to go back to the default filter configuration.
- Click the download icon
next to the Filter icon to download the table as a CSV file.
- Click the link of an account name displayed in the table to go to the account details page.
- Click the link of Download displayed in the Vendor Request and Vendor Response column to download the corresponding txt file of the request and response log from tax vendors.
- View the Zuora internal identifiers of the API calls in the Request ID column. You can find the corresponding value in the API response header.
- Click the link of Details at the end of the row to view the corresponding detailed error message.
- Click a header field to sort the data.