General Structure of Spain VAT Reports
All Spain Localization reports are built using the Tax Reporting Framework SuiteApp.
The Tax Reporting Framework SuiteApp generates reports through a sequence of stages that correspond to the following stages for the Spain reports:
-
Builder Stage
In this stage, one or more queries are executed. These retrieve the information necessary to populate the report. It's done through components called builders, where the purpose of each builder is to produce a query. For instance, a query sourcing summary data for the report header, or a query fetching information about individual transactions. Other builders retrieve data for the Detailed Report page. In the UI, it's accessible after clicking on the linked numeric values in individual report boxes. In this case, the builder produces a query that retrieves details about each transaction tax line.
-
Preprocessor Stage
In this stage, a preprocessor component is associated with a builder (each builder must have an associated preprocessor). After the query produced by the builder is executed, the preprocessor performs computations on each row returned by that query. This can be useful, for example, for mapping data returned by the query to enumerate values, perform validation tasks, log, and so on.
-
Postprocessor Stage
After the preprocessor transforms the data produced by the builder, the postprocessor receives the result of this computation. It can then further manipulate that information before generating the report. If a single report has multiple data sources and multiple preprocessors, the postprocessor makes sure all the information is gathered in one place. This includes objects produced by the preprocessors for all the rows returned by the builders. This enables the process to compute totals, apply filters, log metrics, and provide the final output that will be passed on to the last stage. The object returned by the postprocessor is used to generate the report in a text format and to render the HTML preview page. The latter is defined by a Freemarker template that, when evaluated with the output of the postprocessor, determines the structure of the page.
-
Export Processor Stage
The export processor is an optional component that receives the output of the postprocessor and uses it to build the textual report. The object produced in this stage evaluates a Freemarker template that defines how the final document is structured.
In the Tax Reporting Framework SuiteApp, each of the components listed above can be extended. For more information, see Building Tax Reports with Tax Reporting Framework.
The following sections explain how each of the Spain reports implements these stages, and which components are available for extension.
All the relative paths to these components should be prefixed with SuiteApps/com.netsuite.spainlocalization/src/. For example, if you want to extend the component builders/modelos/Modelo303SummaryBuilder, you should reference it as SuiteApps/com.netsuite.spainlocalization/src/builders/modelos/Modelo303SummaryBuilder.
When extending an existing component, log the parameters that you get as input to the Script Execution Log. By inspecting the log, you'll be able to understand the object structure and apply your changes. See an example of logging below.
/**
* @NApiVersion 2.1
* @NScriptType plugintypeimpl
*/
define(['N/log'], function (logger) {
return {
// Builder stage
customizeBuilders: () => ([
{
script: 'SuiteApps/com.netsuite.spainlocalization/src/builders/modelos/Modelo303SummaryBuilder',
implementation: (query) => {
logger.debug('Query', query);
return query;
}
}
]),
// Preprocessor stage
customizePreProcessors: () => ([]),
// Postprocessor stage
customizePostProcessors: () => ([]),
// Export processor stage
customizeExportProcessors: () => ([])
};
});
Developing an Extension
When developing an extension, you can choose to customize one or more stages, depending on your business needs. For example, when adding a new box to a report, you typically need to customize a builder to retrieve values from the database. You may have to customize pre- and post-processors to manipulate that data, or to update total boxes. This customizes the export processor that produces the report.
Report extensions are developed through plug-in implementations, as is shown in the following code snippet.
/**
* @NApiVersion 2.1
* @NScriptType plugintypeimpl
*/
define(['N/log'], function (logger) {
return {
// Builder stage
customizeBuilders: () => ([
{
script: 'SuiteApps/com.netsuite.spainlocalization/src/builders/modelos/Modelo303SummaryBuilder',
implementation: (query) => {
logger.debug('Builders', 'Executing builder')
// Add select list items.
const index = query.indexOf('FROM');
query = query.substring(0, index) + ', SUM(tx.taxamount) allTaxAmounts, MAX(s.custrecord_sample_property_m303) customProperty ' + query.substring(index);
// Add a table.
const matches = [...query.matchAll(/WHERE/g)];
query = query.substring(0, matches[1].index) + 'JOIN subsidiary s ON s.id = tx.subsidiary ' + query.substring(matches[1].index);
return query;
}
},
{
script: 'SuiteApps/com.netsuite.spainlocalization/src/builders/DomesticSaleDetailsBuilder',
implementation: (query) => {
logger.debug('Builders', 'Executing detail builder')
return query;
}
}
]),
// Preprocessor stage
customizePreProcessors: () => ([{
script: 'SuiteApps/com.netsuite.spainlocalization/src/processors/modelos/Modelo303SummaryPreProcessor',
implementation: (inputData, processorResult) => {
logger.debug('Preprocessors', 'Executing preprocessor')
processorResult.alltaxamounts += 10;
processorResult.customproperty = processorResult.customproperty == 'T' ? true : false;
return processorResult;
}
}]),
// Postprocessor stage
customizePostProcessors: () => ([
{
script: 'SuiteApps/com.netsuite.spainlocalization/src/processors/modelos/Modelo303SummaryPostProcessor',
implementation: (definition, dataManager, processorResult) => {
logger.debug('Postprocessors', 'Executing postprocessor')
processorResult.alltaxamounts += 10;
return processorResult;
}
},
{
script: 'SuiteApps/com.netsuite.spainlocalization/src/processors/modelos/Modelo303DetailsPostProcessor',
implementation: (definition, dataManager, processorResult) => {
logger.emergency('Postprocessors', 'Executing detail postprocessor for box ' + definition.id)
if (definition.id == 'box1234') {
return [];
}
return processorResult;
}
}]),
// Export processor stage
customizeExportProcessors: () => ([{
script: 'SuiteApps/com.netsuite.spainlocalization/src/processors/modelos/Modelo303TxtProcessor.js',
implementation: (inputData, processorResult) => {
logger.debug('Export processors', 'Executing export processor')
processorResult.modelo303 += 'Custom data: ' + inputData.alltaxamounts;
return processorResult;
}
}])
};
});