Sign in
E-Reporting

Update an e-reporting template

Updates an e-reporting template

put/v1/e-reporting/templates/{key}

Path parameters

keystring required

The unique ID of an E-Reporting template.

Headers

Idempotency-Keystring

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Idstring

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Versionstring

The minor API version.

For a list of available minor versions, see API upgrades.

Zuora-Org-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Request body

namestring

The name of the template. Maximum 100 characters.

ereportingSupplierIdstring

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.

contentstring

The Base64-encoded HTML content of the template. If omitted, the existing content is retained.

Example request

{
  "name": "FR_B2B_INVOICE_REPORTING",
  "ereportingSupplierId": "4028948972a2bf990172bc9b27724ddc",
  "sourceObjectType": "INVOICE",
  "businessCategory": "B2B",
  "content": "PGh0bWw+dGVtcGxhdGU8L2h0bWw+",
  "status": "ACTIVE"
}

Response

OK

processIdstring

The ID of the process that handles the operation.

requestIdstring uuid

Unique identifier of the request.

successboolean

Indicates whether the call succeeded.

idstring

The unique ID of the E-Reporting template.

namestring

The name of the template.

ereportingSupplierIdstring

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.

contentstring

The Base64-encoded HTML content of the template.

templateNumberstring

The system-generated unique number of the E-Reporting template.

createdOnstring date-time

The date and time when the template was created.

updatedOnstring date-time

The date and time when the template was last updated.

Changes