Customizing the Meta File
The Meta File contains all the information required by TRF for working with the report. This includes the setup parameters, standard data sources IDs, data boxes, logo, and setup preferences.
The following are the Meta JSON attributes:
Base Object
The following are the attributes for Base Object:
Attribute |
Type |
Description |
Supported Report Type |
---|---|---|---|
name |
String |
Name of the report. |
All |
id |
String |
ID of the report. |
All |
type |
String |
Report Type, supports one of the following:
|
All |
setup |
ReportSetup |
Contains basic setup such as precision, specific formatting for certain types. |
All |
customHelp |
Map |
Allows to provide Help Page ID to open upon clicking the NetSuite Help button.
|
VAT |
dataType |
DataTypeDefinition Map |
An optional Map for declaring the data types Supplementary/ESL/INTRASTAT report fields
|
VAT |
amountfields |
String[] |
List of field names that are considered as transaction amounts. These values would be processed and totalled by TRF |
VAT |
reports |
TAFReportDefinition[] |
A list of ReportDefinitions specific to Tax Audit Files. |
TAF |
customconfig |
CustomConfig object |
An object that determines contents of the Report Configuration page or what happens when the Configure button is clicked. |
VAT, TAF |
source |
map of SourceDefinition |
A map of source ID definitions. Required keys are:
Please also see Summary.sources |
VAT |
data |
CTRMetaData[] |
Required for VAT Reports. List of CTRMetaData objects determining how TRF would process this report for ReportSchema editing |
VAT |
logo |
Map |
Object of key-value pairs mapping languages and logo file names
|
VAT |
preferences |
PreferenceDefinition |
A PreferenceDefinition object to determine default values for TRF Report Preferences. |
TAF, VAT |
ReportSetup
The following are the attributes for ReportSetup:
Attribute |
Type |
Description |
Supported Report Type |
---|---|---|---|
precision |
Integer |
An integer that determines the number precision for the account. |
All |
availableFilters |
String[] |
List of fields that would be shown as filters on the Setup Tax Return page. List of available values:
|
VAT |
date |
String |
Default date type formatting. |
VAT |
number |
Object |
Default parameters for Number Type formatting. Please see DataTypeFormat for expected attributes. |
VAT |
[dataType] |
Regex String or DataTypeFormat |
Unless specified, accepts a Regex string used to format the given data type. By default, all custom data types are considered strings. If Custom type is not a string, please use: DataTypeFormat: Custom Map that determines custom setup for a certain type. Please see DataTypeFormat table for expected attributes. |
VAT |
generateoutput |
Boolean |
Determines if rendering of output will be done in scheduled script. This is usually done for reports that expects huge volume of data like TAF. |
TAF |
jobSpecificSchemas |
Boolean |
Enables Split Feature. Report can be dynamically separated into multiple files by accounting period. Works only for TAF without TaxPointDate. |
TAF |
compress |
CompressType |
Works only with generateoutput set as True. Resulted file will be compressed archive. |
TAF |
DateTypeFormat
The following are the attributes for DataTypeFormat:
Attribute |
Type |
Description |
Supported Report Type |
---|---|---|---|
precision |
Integer |
For Numeric Types: The precision to be used when printing Numbers as Strings. |
VAT |
decimal |
String |
For Numeric Types: The decimal point/comma to be used when printing Numbers as Strings. |
VAT |
separator |
String |
For Numeric Types: The separator to be used when printing Numbers as Strings. |
VAT |
format |
String |
For Date type formats: The format to be used when printing Dates as Strings. |
VAT |
parent |
String |
The custom data type's parent. |
VAT |
CompressType
The following are the attributes for CompressType:
Attribute |
Type |
Description |
Supported Report Type |
---|---|---|---|
type |
String |
Archive type. One of available type of the N/compress module. Current possible values: "CPIO", "TAR", "TBZ2", "TGZ", "ZIP" |
TAF |
name |
String |
Optional. Name of resulted archive. |
TAF |
Source Definition
Attribute |
Type |
Description |
Supported Report Type |
---|---|---|---|
summary |
String |
id of the source object declared in the corresponding SUMMARY.json file |
VAT |
details |
String |
id of the source object declared in the corresponding DETAILS.json file |
VAT |
CTRMetaData
Attribute |
Type |
Description |
Supported Report Type |
---|---|---|---|
id |
String |
Id of the box/field found in the VAT Report |
VAT |
type |
String |
Determines how the box is shown in Setup Tax Returns Accepted values:
|
VAT |
field |
String |
For standard types only, determines which field will be used to compute for values referencing this box Accepted values:
|
VAT |
CustomConfig
The following are the attributes for CustomConfig:
Attribute |
Type |
Description |
Supported Report Type |
---|---|---|---|
label |
String |
The translation key if you want to replace the label of the "Configure" button. |
All |
title |
String |
The translation key of your configure page's title. |
All |
fields |
FieldDefinition[] |
An array of FieldDefinition objects. |
All |
CustomDrilldownTemplate
Attribute |
Type |
Description |
Supported Report Type |
---|---|---|---|
apprefid |
String |
ID of project |
VAT |
template |
String |
Name of the template (template file string) |
VAT |
xls_template |
String |
Name of the xls drilldown export template (template file string) |
VAT |
FieldDefinition
The following are the attributes for FieldDefinition:
Attribute |
Type |
Description |
Supported Report Type |
---|---|---|---|
id |
String |
Field id, should only contain characters. |
All |
label |
String |
The translation key of your Field label. |
All |
type |
String |
Supports types:
|
All |
required |
Boolean |
Determines if a field is required. |
All |
help |
HelpObject |
An object that contains a help attribute, which should contain a translation key for your field level help.
|
All |
defaultValue |
String |
Default value for the field. |
All |
options |
Options[] |
For SELECT fields, an array of option objects, each with text and value attributes.
|
All |
TAFReportDefinition
The following are the attributes for TAFReportDefinition:
Attribute |
Type |
Description |
Supported Report Type |
---|---|---|---|
data |
String[] |
Data to be used in the template. |
TAF |
type |
String |
Type of the generated report file. If not set, type is taken from name (extension) of the file. |
TAF |
name |
String |
File name for report. |
TAF |
namegenerator |
NameGeneratorDefinition |
If name is not set, namegenerator can be used for dynamic name of the report file. |
TAF |
template |
String |
Name of the template file for report. |
TAF |
split |
Boolean |
Flag jobSpecificSchemas required. This report file will be dynamically split into multiple files by accounting periods. |
TAF |
dynamicData |
String[] |
Flag jobSpecificSchemas and split required. Which data will be dynamically split into multiple files by accounting periods. |
TAF |
NameGeneratorDefinition
The following are the attributes for NameGeneratorDefinition:
Attribute |
Type |
Description |
Supported Report Type |
---|---|---|---|
script |
String |
Service class with method getName(report, reportData) |
TAF |
apprefid |
String |
UUID of localization app. |
TAF |
PreferenceDefinition
The following are the attributes for PreferenceDefinition:
Attribute |
Type |
Description |
Supported Report Type |
---|---|---|---|
defaults |
ReportPreferenceDefaults[] |
An array that would determine default values and options for the preferences of this specific report. |
All |
ispejcompatible |
Boolean |
If report is Period End Journals compatible. |
TAF |
ReportPreferenceDefaults
Attribute |
Type |
Description |
Supported Report Type |
---|---|---|---|
parent |
String |
An array that would determine default values and options for the preferences of this specific report. |
All |
fields |
FieldPreferenceDefaults[] |
If report is Period End Journals compatible. |
TAF |
FieldPreferenceDefaults
Attribute |
Type |
Description |
Supported Report Types |
---|---|---|---|
parent |
String |
Determines which sublist contains this preference. Currently, TRF only supports the "reports" group |
All |
fieldName |
String |
Determines which field should be defaulted using this object Currently, TRF supports the following fields: Start of Tax Year: "starttaxyear" Report.Reporting Frequency : reportingfrequency Report.Use Tax Point Date: usetaxpointdate |
All |
value |
String or boolean |
- |
All |
displayType |
String |
hidden, disabled, readonly, or normal Please see custom field Display types |
All |
options |
Options[] |
For reporting frequency: Determines options to be shown in the Reporting Frequency Selection field
|
All |
Related Topics
- Updating and Modifying the Country Tax Report
- Setting a UUID for your Tax Report
- Customizing the Report Schema in Your Tax Report
- Customizing Your Tax Report Using Saved Searches
- Customizing Your Tax Report Using SuiteQL
- Customizing Your Report Schema
- Customizing the Summary File
- Setting Up Your Registry Records
- Customizing Your Report Processors
- Customizing Your Tax Report Template