Customizing the Report Schema in Your Tax Report

After you copy the CTR files into your project, you can add the new files into your installation scripts.

Add a new entry to str_localized_reports_list.json. Follow the format from the file of the same name from the Country Tax Reports project folder.

The following table describes the required fields in the JSON file:

Attribute	Type	Description
name	string	Name of the report.
country	string	2-character ISO Code corresponding to the report's country.
report	string	Denotes the type of report. Limited to TAF for the sake of this document.
isCountryDefault	boolean	Denotes if the report is the default for the specific country.
uuid	string	The same values as your UUID.
createdBy	string	Denotes the project in which the report was created.
translations	Object	A mapping of translations of the report name to different languages.
details	Array of Report Schema Detail Objects	Denotes an array of different Report Schema Details.

Attribute

Type

Description

name

string

Name of the report.

country

string

2-character ISO Code corresponding to the report's country.

report

string

Denotes the type of report. Limited to TAF for the sake of this document.

isCountryDefault

boolean

Denotes if the report is the default for the specific country.

uuid

string

The same values as your UUID.

createdBy

string

Denotes the project in which the report was created.

translations

Object

A mapping of translations of the report name to different languages.

details

Array of Report Schema Detail Objects

Denotes an array of different Report Schema Details.

Attribute	Type	Description
type	string	Report Schema detail type, can be Summary / META.
schema	string	The schema json file containing the schema detail definition.

Attribute

Type

Description

type

string

Report Schema detail type, can be Summary / META.

schema

string

The schema json file containing the schema detail definition.

The following is a sample entry for the str_localized_reports_list.json file:

          {
  "list": [
    {
      "name": "TAF Search Report",
      "country": "COUNTRY",
      "report": "TAF",
      "isCountryDefault": true,
      "islegacy": true,
      "uuid": "NEW_UUID",
      "createdBy": "com.netsuite.tafsearch",
      "translations": {
        "en_US": "TAF Search Report"
      },
      "details": [
        {
          "type": "Summary",
          "schema": "TAF_SEARCH.json"
        },
        {
          "type": "META",
          "schema": "TAF_SEARCH_META.json"
        }
      ]
    }
  ]
}

Related Topics