---
title: "Retrieve an e-reporting template"
method: GET
path: "/v1/e-reporting/templates/{key}"
tags: ["E-Reporting"]
---

# Retrieve an e-reporting template

`GET /v1/e-reporting/templates/{key}`

Retrieves an e-reporting template.

## Path parameters

- `key` string, required

## Headers

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

## Response `200`

OK

- EReportingTemplateResponse
  - `processId` string — The ID of the process that handles the operation.
  - `reasons` object[] — The container of the error code and message. This field is available only if the `success` field is `false`.
    - `code` string — The error code of response.
    - `message` string — The detail information of the error response
  - `requestId` string, uuid — Unique identifier of the request.
  - `success` boolean — Indicates whether the call succeeded.
  - `id` string — The unique ID of the E-Reporting template.
  - `name` string — The name of the template.
  - `ereportingSupplierId` string — The ID of the E-Reporting supplier (business region) this template belongs to.
  - `sourceObjectType` 'INVOICE' | 'CREDIT_MEMO' | 'DEBIT_MEMO' | 'PAYMENT' | 'REFUND' | 'CREDIT_MEMO_APPLICATION' — The type of source object the template is used for.
  - `businessCategory` 'B2B' | 'B2B_CROSS_BORDER' | 'B2C' | 'B2G' | 'ANY' — The business category this template applies to.
  - `status` 'DRAFT' | 'ACTIVE' | 'INACTIVE' — The status of the template.
  - `content` string — The Base64-encoded HTML content of the template.
  - `templateNumber` string — The system-generated unique number of the E-Reporting template.
  - `createdOn` string, date-time — The date and time when the template was created.
  - `updatedOn` string, date-time — The date and time when the template was last updated.

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

[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)