1. Country-Specific Features
  2. Japan Help Topics
  3. Japanese Invoicing
  4. Japanese Invoice Summary
  5. Customizing the Japanese Invoice Summary XML Template

Customizing the Japanese Invoice Summary XML Template

Note:

The Japan Localization SuiteApp supports only invoice summary templates created in FreeMarker syntax.

You can customize the two default templates from the Japan Localization SuiteApp, consolidated_default_multi_currency_template.xml and consolidated_default_template.xml. Then, your custom templates should be uploaded in the same folder as the default template in the File Cabinet, to make them available for selection when you generate invoice summaries.

Templates must be uploaded to Documents > Files > File Cabinet > SuiteBundles > Bundle 410664 > Invoice Summary Templates folder. Then, add your template files.

To use your custom template, be sure to select it in the Invoice Summary Template field on a Japan subsidiary record for OneWorld accounts, or on the Company Information page if you are not using a OneWorld account. You can check the invoice summary template before generating an invoice summary on the Generate Invoice Summary page, in the Statement Template field.

Invoice Summary Template Number Format and Locale

You can use default templates if your parent company is Japan and the number format on the General Preferences setup follows the Japanese Yen currency format. If you want to change the number format, you must create a customized template. You can use these default templates as a basis for creating custom invoice summary templates.

Invoice Summary Page Number

You can modify the following code for the page number:

          <tfoot>
         <tr>
            <td>
               <table width="182mm">
                  <tr>
                     <td width="150mm" align="right">Page Number</td>
                     <td width="15mm" align="right" style="margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; margin-bottom: 0pt;">
                           <pagenumber />
                     </td>
                     <td width="17mm" align="left" style="margin-left: 0pt; margin-right: 0pt; margin-top: 0pt; margin-bottom: 0pt;">
                           /
                           <pagenumber idref="${‌ids.id}" />
                     </td>
                  </tr>
               </table>
            </td>
         </tr>
</tfoot>

Order of Tax Rates in Tax Details Section

You can display the tax rates in the Tax Details section in descending order, in both consolidated_default_multi_currency_template.xml and consolidated_default_template.xml. To do this, replace the following line of code:

            <#list taxdetails.details as taxdetail>

, with:

            <#list taxdetails.details?sort_by("rate") as taxdetail>

The next time you generate an invoice summary, the tax rates in the Tax Details section will be in descending order.

Invoice Summary Template Header Fields and Placeholders

Invoice Summary Field

XML Template Placeholders

Notes

Document Title

{ids.label.doc_title}

This is a label. It can be changed or hardcoded.

Company Address

${companyInformation.mainaddress_text}

This data is sourced from the Company Information page.

Company Name

${‌companyInformation.companyname}

This data is sourced from the Company Information page.

Customer’s Name

${‌customer.companyname}

This data is sourced from the customer record.

Customer’s Default Address

${‌customer.defaultaddress}

This data is sourced from the customer record.

Invoice Number

${‌ids.tranid}

This data is sourced from the invoice summary record.

Invoice Date

${‌ids.trandate}

This data is sourced from the Statement Date field in the invoice summary record.

Start Date

${ids.custbody_suitel10n_jp_ids_start_date}

This data is sourced from the invoice summary record. This refers to the start date of the Billing Period.

Closing Date

${ids.custbody_suitel10n_jp_ids_cd}

This data is sourced from the Period End Date field in the invoice summary record. This refers to the end date of the Billing Period.

Payment Due Date

${dueDateGroup}

This data is the due dates in transactions.

Net Invoice This Period

${amountSum}

This data is sourced from the transactions per due date.

Note

{ids.label.invoice_details_note}

This adds a note indicating that overdue invoice amounts are net payments.
Note:

To add or indicate bank account details in the invoice summary, you can either manually code the bank account field in template, or source it from a custom record or field either in a customer or subsidiary record. But do not directly use the bank account information in the invoice record.

Summary Table Fields and Placeholders

Invoice Summary Field

XML Template Placeholders

Notes

Balance from Previous Billing Label

{ids.label.prev_balance}

This is a label. It can be changed or hardcoded.

Payment Received this Period Label

{ids.label.payment}

This is a label. It can be changed or hardcoded.

Balance Carried Forward Label

{ids.label.balance_forward}

This is a label. It can be changed or hardcoded.

Total Sales this Period Label

{ids.label.total_sales}

This is a label. It can be changed or hardcoded.

Total Credits this Period Label

ids.label.total_credits

This is a label. It can be changed or hardcoded.

Total Consumption Tax Label

{ids.label.total_tax}

This is a label. It can be changed or hardcoded.

Net Invoice this Period Label

{ids.label.total}

This is a label. It can be changed or hardcoded.

Total Amount Due Label

{ids.label.total_amount_due}

This is a label. It can be changed or hardcoded.

Balance from Previous Billing Amount

${ids.custbody_suitel10n_jp_ids_total_prev_p}

This data is sourced from the invoice summary transaction record.

Payment Received this Period Amount

${ids.custbody_suitel10n_jp_ids_prd_payment}

This data is sourced from the invoice summary transaction record.

Balance Carried Forward Amount

${ids.custbody_suitel10n_jp_ids_balance_fwd}

This data is sourced from the invoice summary transaction record.

Total Sales this Period Amount

${ids.custbody_suitel10n_jp_ids_total_sales}

This data is sourced from the invoice summary transaction record.

Total Credits this Period Amount

${ids.custbody_suitel10n_jp_ids_total_return}

This data is sourced from the invoice summary transaction record.

Total Consumption Tax Amount

${ids.custbody_suitel10n_jp_ids_total_tax}

This data is sourced from the invoice summary transaction record.

Net Invoice this Period Amount

${ids.custbody_suitel10n_jp_ids_net_invoice}

This data is sourced from the invoice summary transaction record.

Total Amount

${ids.custbody_suitel10n_jp_ids_net_total}

This data is sourced from the invoice summary transaction record.

Transaction Details Table Fields and Placeholders

Invoice Summary Field

XML Template Placeholders

Notes

Transaction Date Label

{ids.label.tran_date}

This is a label. It can be changed or hardcoded.

Transaction Number Label

{ids.label.tran_no}

This is a label. It can be changed or hardcoded.

Transaction ID Label

ids.label.tran_id

This is a label. It can be changed or hardcoded.

Item Code Label

{ids.label.item_code}

This is a label. It can be changed or hardcoded.

Item Quantity Label

{ids.label.item_quantity}

This is a label. It can be changed or hardcoded.

Currency Label

{ids.label.currency}

This is a label. It can be changed or hardcoded.

Exchange Rate Label

{ids.label.exchange_rate}

This is a label. It can be changed or hardcoded.

Foreign Amount Label

{ids.label.foreign_amount}

This is a label. It can be changed or hardcoded.

Item Price Label

{ids.label.item_price}

This is a label. It can be changed or hardcoded.

Tax Label

{ids.label.line_tax}

This is a label. It can be changed or hardcoded.

Amount Label

{ids.label.line_amount}

This is a label. It can be changed or hardcoded.

Due Date Label

{ids.label.line_due_date}

This is a label. It can be changed or hardcoded.

Transaction Date Value

${‌transaction.trandate}

This data is sourced from the transaction record.

Transaction Number Value

${‌transaction.transactionnumber}

This data is sourced from the transaction record.

Transaction ID Value

transaction.tranid

This data is sourced from the transaction record.

Item Code Value

${‌transaction.item}

This data is sourced from the transaction record.

Item Quantity Value

${‌transaction.quantity}

This data is sourced from the transaction record.

Currency Value

${‌transaction.currency}

This data is sourced from the transaction record.

Exchange Rate Value

${‌transaction.exchangerate}

This data is sourced from the transaction record.

Foreign Value

${‌transaction.fxamount}

This data is sourced from the transaction record.

Item Price Value

${‌transaction.rate}

This data is sourced from the transaction record.

Item Tax Value

${‌transaction.taxamount}

This data is sourced from the transaction record.

Item Amount

${‌transaction.formulacurrency}

This data is sourced from the transaction record.

Due Date

For invoices:

${‌transaction.duedate}

For credit memos:

${transaction.custbody_jp_invoice_summary_due_date}

This data is sourced from the transaction record.
Note:

In addition to the fields in the previous table, the field PO#, ${‌transaction.otherrefnum}, in invoice and credit memo records can also be used in the invoice summary template. Aside from these, other fields in transaction records cannot be added yet.

Tax Details Table Fields and Placeholders

Invoice Summary Field

XML Template Placeholders

Notes

Tax Details Label

{ids.label.tax_details}

This is a label. It can be changed or hardcoded.

Tax Code Label

{ids.label.tax_code}

This is a label. It can be changed or hardcoded.

Tax Rate Label

{ids.label.tax_rate}

This is a label. It can be changed or hardcoded.

Total Net Amount Label

{ids.label.total_net_amount}

This is a label. It can be changed or hardcoded.

Total Tax Label

{ids.label.total_tax_details}

This is a label. It can be changed or hardcoded.

Tax Code Name

${‌taxdetail.name}

This data is sourced from the transaction record.

Tax Rate

${‌taxdetail.rate}%

This data is sourced from the transaction record.

Total Net Amount

${taxdetail.netamountnotax?number?string["#,##0.00"]}

This data is sourced from the transaction record.

Total Tax

${taxdetail.taxamount?number?string["#,##0.00"]}

This data is sourced from the transaction record.

Payment Details Table Fields and Placeholders

Invoice Summary Field

XML Template Placeholders

Notes

Payment Details Section Title

{ids.label.payment_details_title}

This is a label. It can be changed or hardcoded.

Date Label

{ids.label.payment_date}

This is a label. It can be changed or hardcoded.

Payment Transaction Number Label

{ids.label.payment_no}

This is a label. It can be changed or hardcoded.

Transaction Details Label

{ids.label.payment_details}

This is a label. It can be changed or hardcoded.

Payment Transaction ID Label

{ids.label.payment_id}

This is a label. It can be changed or hardcoded.

Currency Label

{ids.label.payment_currency}

This is a label. It can be changed or hardcoded.

Exchange Rate Label

{ids.label.payment_exchangerate}

This data is sourced from the transaction record.

Foreign Amount Label

{ids.label.payment_fxamount}

This data is sourced from the transaction record.

Amount Label

{ids.label.payment_amount}

This data is sourced from the transaction record.

Payment Date

${‌paymentdetail.trandate}

This data is sourced from the payment transaction record.

Payment Transaction Number

${‌paymentdetail.transactionnumber}

This data is sourced from the payment transaction record.

Payment Transaction Details

${paymentdetail.custbody_suitel10n_jp_paydetails}

This data is sourced from the payment transaction record.

Payment Transaction ID

${‌paymentdetail.tranid}

This data is sourced from the payment transaction record.

Payment Currency

${‌paymentdetail.currency}

This data is sourced from the payment transaction record.

Payment Exchange Rate

${‌paymentdetail.exchangerate}

This data is sourced from the payment transaction record.

Payment Foreign Amount

${paymentdetail.formulacurrency_fxamount}

This data is sourced from the payment transaction record.

Payment Amount

${paymentdetail.formulacurrency_netamount}

This data is sourced from the payment transaction record.

Example of an Invoice Summary PDF File

Invoice Summary PDF file

Related Topics

Japanese Invoice Summary
Setting the Preferred Form for the Invoice Summary Record
Setting Up Auto-Generated Invoice Summary Numbers
Setting the Invoice Summary Template
Adding Field Values to the Invoice Summary Output
Specifying a Folder to Save Invoice Summaries In
Generating a Japanese Invoice Summary
Regenerating an Invoice Summary for a Customer
Viewing Invoice Summary Generation Status
Invoice Summary Generation Errors

General Notices