Skip to main content

Support Multiple Languages in Billing Document Templates

Zuora

Support Multiple Languages in Billing Document Templates

If you operate a global business with customers in multiple languages, you can dynamically generate PDF files for billing documents, including invoices, credit memos, and debit memos, in your customers' preferred languages using one template.

This article describes the process of setting up and generating PDF files for billing documents in multiple languages.

Zuora translates only text-based merge fields using the uploaded translation profile. It selects the language for translation using the locale in customer's communication profile. If the translation profile does not contain a column for the customer's communication profile locale, the original untranslated value for the merge field is used.

Date and numeric merge fields are formatted based on the locale in the customer's communication profile.

To generate PDF files for billing documents in multiple languages:

  1. Enable the localization of billing documents in PDF in your tenant.
  2. Create and upload a translation profile file for the languages you want to translate your billing document PDF files into.
  3. Edit and generate invoice PDF files or memo PDF files. You do not need to make any additional change to billion document templates for translation.

Enable Multilingual Billing Document Templates in the Tenant

To enable the localization of billing documents in PDF in your tenant, perform the following steps through the Zuora UI:

  1. Click your username at the top right and navigate to Billing > Manage Billing Document Configuration.
  2. Click the Translation Profile tab.
  3. In the Translation Profile area, click edit.
  4. From the Enable PDF Translation? list, select Yes.
  5. Click save to save the configurations.

Create and Upload a Translation Profile

A merge field value can be translated if all of the following are true about the merge field:

  • A supported merge field name or SPECIAL.PPOC is used.
  • The merge field is not marked as untranslatable.
  • The field type is string.

See Merge Fields for Invoices, Merge Fields for Credit Memos, or Merge Fields for Debit Memos for the names, types, and translatability of merge fields.

To create and upload a translation profile:

  1. In the Translation Profile Detail section, click export. A sample translation file is downloaded.

  2. The translation file contains only the MergeFieldName and OriginalValue columns.

    • MergeFieldName: Merge Field Name as it appears in the billing document template.

    • OriginalValue: The value given in the language of your tenant. The maximum allowed length is 500 characters.

  3. Add a language you want to translate to in each of the remaining columns. Type the language code in the column heading, e.g. de-DE. The language codes are case-sensitive. You need to type exactly as shown in the list below. The maximum allowed length is 500 characters.

  4. Save the translation file. If you use Microsoft Excel to edit the translation file, save the file in the Windows Comma Separated (.csv) format. 
    warning.png Do not save in the MS-DOS Comma Separated (.csv) format.
    warning.png You must save the translation file in the UTF-8 Format.

  5. In the Import Translation Profile section, click Choose File, select the translation CSV file, and click import.

  6. Review the import summary and click OK.

  7. Click and select a language in the translation file to review the translation.

  8. Now you can manage billing document template files and generate billing document PDF files as described in Customize Billing Document Templates Using Word Mail Merge.

With the example translation profile below, the two merge fields would render translated values since these were the only two provided in the translation profile. All other merge fields would be displayed in the default language used in the product catalog.

MergeFieldName OriginalValue fr-FR de-DE
Subscription.Product.
Name
Best Product Ever Meilleur Produit Jamais Beste Product aller Zeiten
Subscription.RatePlan.
Name
Best Product Ever -
Gold Edition
Meilleur Produit Jamais - Edition d'Or Beste Produkt aller Zeiten - Gold Edition

Translate Strings for Proration, Prepayment, Overage, and Credit

In addition to the supported merge fields, you can translate the following strings using the SPECIAL.PPOC merge field:

  • — Proration
  • — Prepayment
  • — Overage
  • Credit
  • — Proration Credit
  • — Prepayment Credit

The above SPECIAL.PPOC strings are suffixes appended to invoice or memo item names for a proration, a prepayment, an overage, or a credit. For example, the prorated invoice item name would be "XXX -- Proration" for the invoice or memo item named, "XXX". Invoice or memo items with the SPECIAL.PPOC suffixes are translated separately from the regular invoice or memo item names.

SPECIAL.PPOC is not a true mail merge field and cannot be used in billing document templates.

Do not use any of the above SPECIAL.PPOC strings at the end of your charge names, or the charge name may be incorrectly translated.

The following is an example translation profile for the special merge fields.

MergeFieldName OriginalValue ja-JP
SPECIAL.PPOC -- Overage 過剰
SPECIAL.PPOC -- Prepayment 払い
SPECIAL.PPOC -- Proration 比例配分
SPECIAL.PPOC Credit クレジット

 

Supported Languages

The language country codes are comprised of two arguments separated by a dash, for example fr-CA is French Canadian:

  • The first argument is a valid ISO Language Code. These codes are the lower-case two-letter codes as defined by ISO-639. 
  • The second argument to both constructors is a valid ISO Country Code. These codes are the upper-case two-letter codes as defined by ISO-3166. 

Billing document template merge fields can be translated into the following languages. 

  • en-US
  • en-GB
  • de-AT
  • de-DE
  • de-LU
  • de-CH
  • fr-BE
  • fr-CA
  • fr-FR
  • fr-LU
  • fr-CH
  • it-IT
  • it-CH
  • es-AR
  • es-BO
  • es-CL
  • es-CO
  • es-CR
  • es-DO
  • es-EC
  • es-SV
  • es-GT
  • es-HN
  • es-MX
  • es-NI
  • es-PA
  • es-PY
  • es-PE
  • es-PR
  • es-ES
  • es-US
  • es-UY
  • es-VE
  • nl-BE
  • nl-NL
  • pl-PL
  • pt-BR
  • pt-PT
  • el-CY
  • el-GR
  • da-DK
  • ja-JP
  • cs-CZ
  • ro-RO
  • sk-SK
  • sl-SI
  • da-DK
  • no-NO
  • sv-SE
  • fi-FI
  • el-GR
  • hu-HU
  • bg-BG
  • et-EE
  • lv-LV
  • tr-TR
  • ar-AE
  • ar-JO
  • ar-SY
  • ar-BH
  • ar-SA
  • ar-YE
  • ar-EG
  • ar-SD
  • ar-TN
  • ar-IQ
  • ar-MA
  • ar-QA
  • ar-OM
  • ar-KW
  • ar-LY
  • ar-DZ
  • ar-LB
  • zh-CN
  • zh-SG
  • zh-TW
  • ru-RU
  • th-TH

Limitations

The localization of billing documents in PDF has the following limitations:

  • A Zuora tenant can contain 5,000 translations for billing document PDF files. If you upload multiple translation profiles, the sum of all the translated merge field values should be less than 5,000 rows. 
  • Translations cannot be removed.
  • Translation messages cannot be updated directly through the Zuora UI. To update a translation, you have to upload a new translation file with the updated message.

Known Issue

Do not use Excel on Mac systems to create a translation profile file for multi-byte languages. The characters may not be saved correctly.

We recommend Google Spreadsheet or a plain text editor, such as Sublime, to create a translation profile on Mac.