1. Accounting
  2. Taxation
  3. Tax Reporting Framework
  4. Tax Reporting Framework
  5. Building Tax Reports with Tax Reporting Framework
  6. Updating and Modifying the Country Tax Report
  7. Customizing the Summary File

Customizing the Summary File

The Summary file contains information required by Tax Reporting Framework to generate tax reports and its corresponding drill-down data. This includes data sources, its filters, summarization and post processing.

The following are the attributes you need to customize for the summary file:

Schema Object

The following table contains the attributes for Schema Object:

Attribute

Type

Required

Description

Supported Report Types

name

String

Y

Name of the Report.

All

id

String

Y

ID of the Report+Detail type.

All

type

String

Y

Report Type, supports one of the following:

  • VAT

  • TAF

  • ESL

  • SUPPLEMENTARY

  • INTRASTAT

All

split

Boolean

N

Required jobSpecificSchemas in meta.

This summary file will be divided into multiple summary files per accounting period.

All

context

ContextDefinition

Y

Allows you to set the context for report generation.

With the context object, you can pass parameters to the report generation processes.

All

source

SourceDefinition[]

Y

Allows you to set the data sources to be used by your report.

These sources can be generated using Searches or by loading records.

All

data

DataDefinition[]

Y

—

All

template

TemplateDefinitionMap

N

—

VAT

ContextDefinition

The following table contains the attributes for ContextDefinition:

Attribute

Type

Description

Supported Report Types

report

ReportContextDefinition

 
                      "context": {
    "report": {
        "nexus": "reportparam.nexus",
        "subsidiary": "reportparam.subsidiary",
        "accountingcontext": {
            "source": "SuiteApps/com.netsuite.suitetaxreports/src/app/service/AccountingContextService"
        }
    }
},

All

ReportContextDefinition

The following table contains the attributes for ReportContextDefinition:

Attribute

Type

Description

Supported Report Types

[parameter name]

String or ContextParameterDefinition

—

All

ContextParameterDefinition

The following table contains the attributes for ContextParameterDefinition:

Attribute

Type

Required

Description

Supported Report Types

source

String

Y

Absolute file cabinet path of your Custom data source class.

Please see Classes for more Information.

All

options

Object

N

Key-value map that will serve as parameters for your custom source script.

All

SourceDefinition

The following table contains the attributes for SourceDefinition:

Attribute

Type

Required

Description

Supported Report Types

id

String

Y

The ID you can use to reference this for data retrieval.

All

type

String

Y

Determines the type of the source. Accepts the following types:

  • record

  • config

  • savedsearch

  • searchtask

All

recordtype

String

Y

 

All

recordid

String

Y

 

All

fields

String[]

N

 

All

sublistfields:

SublistSourceDefinition[]

N

 

All

internalid

String

Y

 

All

isPEJCompatible

Boolean

 

If this search should use Period End Journals entries.

TAF

filters

String or (String or FilterDefinition)[]

N

Only for savedsearch and searchtask types, allows filtering of source data. Variable of already existing filters can be used, like "STR_BASE_TRANSACTION_FILTERS"

All

processor

ProcessorDefinition

Y

Only for savedsearch and searchtask types, allows special processing of the data before being used as a data source for the report.

All

validator

Object with "script" parameter

N

Sets a script that would validate whether the current data source is valid for the NS Account and the report context.

                      "validator": {
    "script": "SuiteApps/com.netsuite.suitetaxreports/src/app/validator/MXLocalizationValidator"},

All

SublistSourceDefinition

The following table contains the attributes for SublistSourceDefinition:

Attribute

Type

Required

Description

Supported Report Types

name

String

Y

The sublist name as defined in the Records Browser.

All

fields

String[]

Y

A list of fields of the sublist as defined in the Records Browser.

All

FilterDefinition

The following table contains the attributes for FilterDefinition:

Attribute

Type

Required

Description

Supported Report Types

name

String

Y

Name of the field being used as a filter.

All

operator

String

Y

Operator used for the filter.

All

formula

String

N

Formula string if name is formula type.

Is split flag is true, placeholders "%startdate%" and "%enddate%" can be used.

All

values

String

Y

A reference to the context field used for the filter.

All

join

String

N

Join field if applicable.

All

required

RequirementDefinition

 

Determines whether a Filter will be used when retrieving data.

All

RequirementDefinition

The following table contains the attributes for RequirementDefinition:

Attribute

Type

Required

Description

Supported Report Types

features

String[]

N

A list of feature IDs that would be required by TRF before using the filter.

Placing the character "!" before feature name causes negative effect.

All

report

ReportRequirementDefinition[]

N

A list of objects that TRF would use to determine whether a filter should be used, based on the report context.

All

ReportRequirementDefinition

The following table contains the attributes for ReportRequirementDefinition:

Attribute

Type

Required

Description

Supported Report Types

field

String

Y

Name of the report context field to be compared to the list of values.

All

values

String[] or Boolean[]

Y

A list of values that would be compared to the given report context field.

All

ProcessorDefinition

The following table contains the attributes for ProcessorDefinition:

Attribute

Type

Required

Description

Supported Report Types

type

String

Y

Type of the processor. Accepts the following types:

  • scheduled

  • mapreduce

All

script

String

Y

Absolute path of the processor's javascript class, should be from the "SuiteApps" folder.

All

DataDefinition

The following table contains the attributes for DataDefinition:

Attribute

Type

Required

Description

Supported Report Types

id

String

Y

Id of the data node.

All

type

String

Y

Type of the node. Optional and currently, only supports the DERIVED type.

DERIVED type should only be used on VAT Summaries and should never be used on VAT Details schema.

All

source

String[]

Y

A string of data source ids.

All

field

DataFieldDefinition[]

N

—

All

sort

DataSortDefinition[]

N

An array of sorting definitions, data will be sorted based on their order in the array.

All

selector

Selector

N

Selector object used to further filter data from sources. As TRF uses lokijs for loading data sources, see https://github.com/techfort/LokiJS/wiki/Query-Examples as a reference for creating your selector.

All

DataFieldDefinition

The following table contains the attributes for DataFieldDefinition:

Attribute

Type

Required

Description

Supported Report Types

id

String

Y

This makes the new column name.

All

value

String

Y

The data-source column.

For DERIVED types, this is a reference to retrieve data from other sources. Possible uses:

Value is computed from other data nodes in the format of [datanode id].[field id].

                      "value": "box101_1.netamount + box101_2.netamount"

Value is computed from fields form the current data node in the format: this.[field id].

                      "value": "this.box103 + this.box104"

All

summarytype

String

N

Summary type to be applied on the retrieved data. Currently accepts the following values:

  • group

  • sum

All

DataSortDefinition

The following table contains the attributes for DataSortDefinition:

Attribute

Type

Required

Description

Supported Report Types

field

String

Y

Sort by field.

All

type

String

Y

DataType of the field, determines how data is to be sorted. Currently accepts the following types.

  • STRING

  • DATE

  • NUMBER

All

order

String

Y

Determines whether data is sorted by:

  • ASC - Ascending order

  • DESC - Descending order

All

TemplateDefinitionMap

The following table contains the attributes for TemplateDefinitionMap:

Attribute

Type

Description

Supported Report Types

html

pdf

xls

xml

TemplateDefinition

The template for the export functionality for the specific file type.

VAT

TemplateDefinition

The following table contains the attributes for TemplateDefinition:

Attribute

Type

Required

Description

Supported Report Types

[2-letter language code]

String or Object

Y

The file name of the template to be used for the given language or an object containing the "name" of the language and the name of the template "file".

                      "html": {
    "en": { "name" : "Canada", "file" : "VAT_HTML_CA_ENG.html" }
},
"pdf": {
    "en": "VAT_PDF_CA_ENG.xml"
}

VAT

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 Meta File
Setting Up Your Registry Records
Customizing Your Report Processors
Customizing Your Tax Report Template

General Notices