Skip to main content

Predefined data tables for billing documents

Zuora

Predefined data tables for billing documents

  • For invoices: Charge Details, Tax Summary, Transactions, and Usage Details components
  • For credit memos: Credit Memo Details and Tax Summary components
  • For debit memos: Debit Memo Details and Tax Summary components

To configure data tables, you can drag any sample table components with predefined data into an HTML template, and then make adjustments as needed. For example, after clicking the table displayed in the HTML template, you can make updates in the Columns section of the displayed Content tab:

  • Click the Edit icon in the corresponding row to update the name of column headers, and the width and alignment of each column.
  • Use the Action checkbox in the corresponding row to determine whether a column is displayed in HTML templates.

In HTML templates, you can also configure data tables from scratch. To learn more information about customizing data tables, see Configure data tables in HTML templates.

Predefined data tables for invoices

The online HTML template editor provides the Charge Details, Tax Summary, Transactions, and Usage Details component with predefined data tables for invoices.

Charge Details table

By dragging the Charge Details component from the Content tab into an HTML invoice template, you can see a predefined Charge Details table displayed in the template. This table displays discounts inline with regular charges.

The following table lists the details of the predefined Charge Details table for invoices.

Column header Description Default display
Charge Name The name of the charge. Yes
Quantity The quantity of this invoice item in the configured unit of measure for the charge. Yes
Unit Price The unit price of the rate plan charge associated with the invoice item. Yes
Service Period The period from the service start date to the service end date of the charge.
When this field is used for sorting, data is sorted by alphabet.
Yes
Subtotal The subtotal of all charges without any discounts or taxes. Yes
Discount The discount applied to the charge. Yes
Tax The tax amount of the charge used in the calculation. Yes
Total The total amount of the charge with the calculation of tax and discount. Yes
Charge Number The number of the charge. No
Subscription Number The number of the subscription associated with the invoice item. No
Rate Plan Name The name of the rate plan associated with the invoice item. No
Product Name The name of the product associated with the invoice item. No
Product Description The item description in the product catalog. No

By default, this table has sorting and filtering configurations, and the following list demonstrates the descriptions of predefined fields in these configurations:

  • Sorting configuration in the Sort By section
    • RatePlanCharge.ChargeNumber: sorts records in the data table by charge number in descending order.
    • ServiceStartDate: sorts records in the data table by service start date in ascending order.
    • Quantity: sorts records in the data table by quantity in ascending order.
  • Filtering configuration in the Filters section
    • ProcessingType: filters records whose processing type is not equal to 1, indicating discount charges. 
      For more information about the processing type values and their meanings, see the field in the response body of the "CRUD: Retrieve an invoice item" operation.

You can add, delete, and edit the fields for sorting, grouping, and filtering configurations as needed. For example, you can customize the grouping configuration, which does not have predefined fields in Charge Details tables, by the following actions in the Group By section:

  • Click Add to add a field used for grouping.
  • Click the Delete icon in the corresponding row to remove the field used for grouping.
  • Click the Edit icon in the corresponding row to change the field used for grouping.

Note that you can configure a maximum of three fields for each of sorting, grouping, and filtering configurations.

Tax Summary table

By dragging the Tax Summary component from the Content tab into an HTML invoice template, you can see a predefined Tax Summary table displayed in the template. 

The following table lists the details of the predefined Tax Summary table for invoices.

Column header Description Default display
Tax Name The name of the tax rate, which is displayed on invoices. Yes
Tax Rate The tax rate applied to the charge. Yes
Tax Rate Type The type of the tax rate applied to the charge. Yes
Tax Amount The amount of the tax applied to the charge. Yes
Charge Amount The subtotal of all charges without any taxes. No

By default, this table has sorting and grouping configurations, and the following list demonstrates the descriptions of predefined fields in these configurations:

  • Sorting configuration in the Sort By section
    • Name: sorts records in the data table by name in ascending order.
  • Grouping configuration in the Group By section
    • Name: groups records in the data table by name.
    • TaxRateType: groups records in the data table by tax rate type.
    • TaxRate: groups records in the data table by tax rate.

You cannot add, delete, or edit the fields for each of sorting, grouping, and filtering configurations.

Transactions table

By dragging the Transactions component from the Content tab into an HTML invoice template, you can see a predefined Transactions table displayed in the template. 

  • If you have the Invoice Settlement feature enabled, information about Credit Memos and Payments are displayed in the Transactions table on generated PDF files.
  • If you have the Invoice Settlement feature disabled, information about Payments, Refunds, Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments are displayed in the Transactions table on generated PDF files.

The following table lists the details of the predefined Transactions table for invoices.

Column header Description Default display
Transaction Type The type of the transaction. Yes
Transaction Date The date of the transaction. Yes
Transaction Number The number of the transaction. Yes
Description The description of the transaction. Yes
Payment Method Type The type of the payment method associated with the transaction. Yes
Payment Method Number The number of the payment method associated with the transaction. Yes
Applied Amount The amount of this transaction applied to invoices. Yes

By default, this table has a sorting configuration, and the following list demonstrates the descriptions of predefined fields in the configuration:

  • Sorting configuration in the Sort By section
    • TransactionDate: sorts records in the data table by transaction date in ascending order.
    • TransactionNumber: sorts records in the data table by transaction number in ascending order.

You can add, delete, and edit the fields for sorting, grouping, and filtering configurations as needed. For example, you can customize the grouping configuration, which does not have predefined fields in Transactions tables, by the following actions in the Group By section:

  • Click Add to add a field used for grouping.
  • Click the Delete icon in the corresponding row to remove the field used for grouping.
  • Click the Edit icon in the corresponding row to change the field used for grouping.

Note that you can configure a maximum of three fields for each of sorting and grouping configurations. For the filtering configuration, you can configure multiple filters based on the available fields as needed. 

Usage Details table

By dragging the Usage Details component from the Content tab into an HTML invoice template, you can see a predefined Usage Details table displayed in the template. 

The following table lists the details of the predefined Usage Details table for invoices.

Column header Description Default display
Date The date of the subscription. Yes
Subscription Identifier The identifier of the subscription. Yes
Quantity The quantity of the usage item in the configured unit of measure for the subscription. Yes
UOM The unit of measure for the subscription. Yes
Charge Name The charge name from the subscription. Yes
Charge Number The charge ID from the subscription. No
Rate Plan Name The name of the rate plan from the subscription. No
Product Name The name of the product from the subscription. No

By default, this table has a sorting configuration, and the following list demonstrates the descriptions of predefined fields in the configuration:

  • Sorting configuration in the Sort By section
    • RatePlanCharge.Name: sorts records in the data table by name in ascending order.
    • StartDateTime: sorts records in the data table by start date time in ascending order.

You can add, delete, and edit the fields for sorting, grouping, and filtering configurations as needed. For example, you can customize the grouping configuration, which does not have predefined fields in Usage Details tables, by the following actions in the Group By section:

  • Click Add to add a field used for grouping.
  • Click the Delete icon in the corresponding row to remove the field used for grouping.
  • Click the Edit icon in the corresponding row to change the field used for grouping.

Note that you can configure a maximum of three fields for each of sorting and grouping configurations. For the filtering configuration, you can configure multiple filters based on the available fields as needed.

Predefined data tables for credit memos

The online HTML template editor provides the Credit Memo Details and Tax Summary component with predefined data tables for credit memos.

Credit Memo Details table

By dragging the Credit Memo Details component from the Content tab into an HTML memo template, you can see a predefined Credit Memo Details table displayed in the template. 

The following table lists the details of the predefined Credit Memo Details table for credit memos.

Column header Description Default display
Item Name The name of this credit memo item. Yes
Service Period

The service period of this credit memo item.

When this field is used for sorting, data is sorted by alphabet.

Yes
Quantity The quantity of this credit memo item in the configured unit of measure for the charge. Yes
Tax Amount The tax amount of this credit memo item. Yes
Amount The total amount of this credit memo item without tax. Yes
Description The description of this credit memo item. No
UOM The unit of measure for this credit memo item. No
Unit Price The unit price of the charge associated with the credit memo item. No
Total The total amount of this credit memo item. No
Applied Amount The amount of this credit memo item that is applied to invoices and debit memos. No

By default, this table has a sorting configuration, and the following list demonstrates the descriptions of predefined fields in the configuration:

  • Sorting configuration in the Sort By section
    • ServiceStartDate : sorts records in the data table by service start date in ascending order.
    • ChargeName : sorts records in the data table by charge name in ascending order.

You can add, delete, and edit the fields for sorting, grouping, and filtering configurations as needed. For example, you can customize the grouping configuration, which does not have predefined fields in Usage Details tables, by the following actions in the Group By section:

  • Click Add to add a field used for grouping.
  • Click the Delete icon in the corresponding row to remove the field used for grouping.
  • Click the Edit icon in the corresponding row to change the field used for grouping.

Note that you can configure a maximum of three fields for each of sorting and grouping configurations. For the filtering configuration, you can you can configure multiple filters based on the available fields as needed.

Tax Summary table

By dragging the Tax Summary component into an HTML memo template, you can see a predefined Tax Summary table displayed in the template, as shown in the following screenshot. 

The following table lists the details of the predefined Tax Summary table for credit memos.

Column header Description Default display
Tax Name The name of the tax rate, such as sales tax or GST. This name is displayed on invoices. Yes
Tax Rate The tax rate applied to the charge. Yes
Tax Rate Type The type of the tax rate applied to the charge. Yes
Tax Amount The amount of the tax applied to the charge. Yes
Charge Amount The subtotal of all charges without any taxes. No

By default, this table has sorting and grouping configurations, and the following list demonstrates the descriptions of predefined fields in these configurations:

  • Sorting configuration in the Sort By section
    • Name: sorts records in the data table by name in ascending order.
  • Grouping configuration in the Group By section
    • Name: groups records in the data table by name.
    • TaxRateType: groups records in the data table by tax rate type.
    • TaxRate: groups records in the data table by tax rate.

You cannot add, delete, or edit the fields for each of sorting, grouping, and filtering configurations.

Predefined data tables for debit memos

The online HTML template editor provides the Debit Memo Details and Tax Summary components with predefined data tables for debit memos.

Debit Memo Details table

By dragging the Debit Memo Details component from the Content tab into an HTML memo template, you can see a predefined Debit Memo Details table displayed in the template. 

The following table lists the details of the predefined Debit Memo Details table for debit memos.

Column header Description Default display
Item Name The name of this debit memo item. Yes
Service Period

The service period of this debit memo item.

When this field is used for sorting, data is sorted by alphabet.

Yes
Quantity The quantity of this debit memo item in the configured unit of measure for the charge. Yes
Tax Amount The tax amount of this debit memo item. Yes
Amount The total amount of this debit memo item without tax. Yes
Description The description of this debit memo item. No
UOM The unit of measure for this debit memo item. No
Unit Price The unit price of the charge associated with the debit memo item. No
Total The total amount of this debit memo item. No

By default, this table has a sorting configuration, and the following list demonstrates the descriptions of predefined fields in the configuration:

  • Sorting configuration in the Sort By section
    • ServiceStartDate : sorts records in the data table by service start date in ascending order.
    • ChargeName : sorts records in the data table by charge name in ascending order.

You can add, delete, and edit the fields for sorting, grouping, and filtering configurations as needed. For example, you can customize the grouping configuration, which does not have predefined fields in Usage Details tables, by the following actions in the Group By section:

  • Click Add to add a field used for grouping.
  • Click the Delete icon in the corresponding row to remove the field used for grouping.
  • Click the Edit icon in the corresponding row to change the field used for grouping.

Note that you can configure a maximum of three fields for each of sorting and grouping configurations. For the filtering configuration, you can configure multiple filters based on the available fields as needed.

Tax Summary table

By dragging the Tax Summary component into an HTML template for debit memos, you can see a predefined Tax Summary table displayed in the template, as shown in the following screenshot. 

The following table lists the details of the predefined Tax Summary table for debit memos.

Column header Description Default display
Tax Name The name of the tax rate, such as sales tax or GST. This name is displayed on invoices. Yes
Tax Rate The tax rate applied to the charge. Yes
Tax Rate Type The type of the tax rate applied to the charge. Yes
Tax Amount The amount of the tax applied to the charge. Yes
Charge Amount The subtotal of all charges without any taxes. No

By default, this table has sorting and grouping configurations, and the following list demonstrates the descriptions of predefined fields in these configurations:

  • Sorting configuration in the Sort By section
    • Name: sorts records in the data table by name in ascending order.
  • Grouping configuration in the Group By section
    • Name: groups records in the data table by name.
    • TaxRateType: groups records in the data table by tax rate type.
    • TaxRate: groups records in the data table by tax rate.

You cannot add, delete, or edit the fields for each of sorting, grouping, and filtering configurations.

Transactions table

By dragging the Transactions component from the Content tab into an HTML template for debit memos, you can see a predefined Transactions table displayed in the template. 

  • If you have the Invoice Settlement feature enabled, information about Credit Memos and Payments are displayed in the Transactions table on generated PDF files.
  • If you have the Invoice Settlement feature disabled, information about Payments, Refunds, Invoice Adjustments, Invoice Item Adjustments, and Credit Balance Adjustments are displayed in the Transactions table on generated PDF files.

The following table lists the details of the predefined Transactions table for debit memos.

Column header Description Default display
Transaction Type The type of the transaction. Yes
Transaction Date The date of the transaction. Yes
Transaction Number The number of the transaction. Yes
Description The description of the transaction. Yes
Applied Amount The amount of this transaction applied to invoices. Yes
Payment Method Type The type of the payment method associated with the transaction. No
Payment Method Number The number of the payment method associated with the transaction. No

By default, this table has a sorting configuration, and the following list demonstrates the descriptions of predefined fields in the configuration:

  • Sorting configuration in the Sort By section
    • TransactionDate: sorts records in the data table by transaction date in ascending order.
    • TransactionNumber: sorts records in the data table by transaction number in ascending order.

You can add, delete, and edit the fields for sorting, grouping, and filtering configurations as needed. For example, you can customize the grouping configuration, which does not have predefined fields in Transactions tables, by the following actions in the Group By section:

  • Click Add to add a field used for grouping.
  • Click the Delete icon in the corresponding row to remove the field used for grouping.
  • Click the Edit icon in the corresponding row to change the field used for grouping.

Note that you can configure a maximum of three fields for each of sorting and grouping configurations. For the filtering configuration, you can configure multiple filters based on the available fields as needed.