---
title: "List tax system health records"
method: GET
path: "/system-health/tax/details"
tags: ["Tax Health"]
---

# List tax system health records

`GET /system-health/tax/details`

Returns System Health Electronic records that are generated by your Zuora tenant within a specified time range.


You can filter the failure records by one or multiple of the following fields:
  - vendorName
  - eventType
  - status

## Query parameters

- `page` integer
- `pageSize` integer
- `vendorName` string
- `eventType` string
- `status` string
- `sort` string
- `startTime` string, date-time, required
- `endTime` string, date-time, required

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Track-Id` string

## Response `200`

OK

- GetTaxRecordsResponse
  - `data` TaxHealthDetailsRecords[] — List of tax record details.
    - `error_message` string — A detailed error message, if any, associated with the transaction or event.
    - `document_number` string — The document number associated with the transaction, such as an invoice number.
    - `vendor_name` string — The name of the vendor involved in the transaction.
    - `event_source` string — The source of the event, such as a third-party service or system.
    - `error_category` string — The main category of the error, if applicable.
    - `account_id` string — The unique identifier for the account involved in the event or transaction.
    - `event_type` string — The type of event, such as tax generation or another action.
    - `total_duration` integer — The total time taken to process the event or transaction, in milliseconds.
    - `zuora_request_id` string — A unique identifier for the request to the Zuora system.
    - `account_name` string — The name of the account associated with the event or transaction.
    - `vendor_duration` number — The time taken by the vendor to process the request, in milliseconds.
    - `sub_error_category` string — A more specific subcategory of the error, if applicable.
    - `status` 'success' | 'error' — The current status of the event or transaction.
    - `timestamp` string, date-time — The timestamp of the event or transaction in ISO 8601 format.
  - `nextPage` string, url — URL to the next page of results for pagination.

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)