Create an e-invoice file template

Creates an e-invoice file templates for your billing documents, including invoices, credit memos, and debit memos.

Zuora provides default e-invoice file templates, so you can just customize them as needed. For example, some country specific fields like HSN (Harmonized System of Nomenclature) might be stored on product rate plan charges.

Note: This operation is available only if you have the E-Invoicing feature in Early Adopter phase enabled.

Request
header Parameters
Idempotency-Key
string <= 255 characters

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-Encoding
string

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-Encoding
string

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.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
string <= 64 characters

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-Ids
string

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-Org-Ids
string

Comma separated IDs. If you have Zuora Multi-Org 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.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Request Body schema: application/json
required
content
required
string

The content of the e-invoice file template, which must be encoded in Base64 format.

country
required
string

The short name of a country or region where you must comply with e-invoicing requirements. For example, IN for India. For the full list of country names and codes, see View countries or regions.

documentType
required
string

The type of billing documents, which the e-invoice file template is intended for.

Enum: "Invoice" "CreditMemo" "DebitMemo"
name
required
string <= 255 characters

The name of the e-invoice file template.

provider
required
string

The name of an e-invoicing service provider that assists in generating e-invoice files.

Value: "Sovos"
Responses
200
500

Internal Server Error

4XX

Request Errors

post/v1/einvoice/templates
Request samples
application/json
{
  • "content": "base64 encoded content",
  • "country": "IN",
  • "documentType": "Invoice",
  • "name": "Sovos e-invoice service",
  • "provider": "Sovos"
}
Response samples
application/json
{
  • "content": "base64 encoded content",
  • "country": "IN",
  • "documentType": "Invoice",
  • "id": "4028818484f483d20184f5006b97003f",
  • "name": "Sovos e-invoice service",
  • "provider": "Sovos",
  • "success": true,
  • "templateNumber": "EITEMP-00000003"
}