Electronic Invoicing Builder Kit

Create Plugin Implementation

You must have the Administrator role to create the plugin implementations.

You can create plugin implementations of below types using the samples provided as part of EI SuiteApp:

• Avalara Message Process Plugin Type-for document status processing.

• Custom Data Source for E-document-for outbound generation.

You can refer to the already sourced Transaction data available from Electronic Invoicing (refer to CDS data available from EI). If you need to override the available values, you can do it when implementing. If it is not required to override, you do not need to take any action and the values will be used during e-document generation, depending on the template mappings. Refer to the CDS data available from reference Outbound UBL CDS and add the missing or tweak the existing if needed, based on countries' requirement.

For more details on how to create plugin implementation, see Creating a Custom Plug-in Alternate Implementation.

Create Mandate Record

You must have the Administrator role to create the mandate record. A mandate record can be created using builder kit interface:

• Go to Setup > E-Invoicing > Builder Kit

• Create a Mandate record and set:

  • Name: Should be the mandate value supported by Avalara.

  • Plugin implementation script id of 'Avalara Message Process Plugin Type' type created in the previous step, for example-. customscript_msgprocess_belgium.

NSEB Setup

Setup the NetSuite Electronic Business SuiteApp in your sandbox account. For more details, refer to NetSuite Electronic Business Sandbox for the overview and NSEB Sandbox Quick Start for the steps.

As part of the NSEB setup in sandbox, be sure to activate the mandate you created in the previous step. For more details see, Mandate Activation of Avalara Sandbox company.

Creating E-Document Templates using Builder Kit

You must have the Administrator role to create the e-document templates using Builder kit. You can use Builder Kit to create an E-Document Template with ready “starter” details which can be customized according to your needs.

You will need e-document templates to generate e-documents. Builder Kit helps you create e-document templates with standard/starter mappings and the custom data sourcing implementation, that you can further customize according to your needs.

You will be redirected to the created E-Document Template, with the “Template for Outbound E- documents” and “Custom Data Source Plugin Implementation” already populated, based on your selection of Outbound Starter and Outbound CDS.

Similarly, if you provided a choice for Inbound Starter, Inbound CDS, and Inbound XSD, the newly created E-Document Template record contains “Field Mapping for Inbound E-documents” already populated, based on your selection.

You can always modify these field values in the created E-Document Template by navigating to the record by going to Setup > Electronic Invoicing > E-Document Templates.

Create the Required Custom Fields

The country mandate or network to which the e-documents are sent (for example-PEPPOL) might require associated values to be stored with an invoice, before the e-document is generated and sent, and after the e-document is sent.

You may need to "create custom fields" depending on your country mandate. These custom fields could be used by you for two different purposes:

• Values that should be stored before e-document generation, and to be used during e-document generation:

  A custom transaction body field can be used to store values that can be sourced and used in the generated e-document using Outbound CDS.

  For example: a value associated with the invoice, required to be present in the generated e-document.

• Values that should be stored as result of sending out an e-document:

  Custom transaction body fields can be used store the results of sending the e-document to tax authority or networks like PEPPOL.

  For example: Unique ID of document generated by tax authority, digital signatures etc.

Additional Setup for Inbound

Inbound e-documents can be supported by implementing the following Builder kit created components:

• E-Documents Templates (Inbound)-Be sure to configure the Inbound Details when creating the E-Document Template using Builder Kit. For more information, see Creating E-Document Templates using Builder Kit.

• You must create the Plugin Implementation to resolve/select/set the Vendor based on custom logic. Create a custom plugin implementation of type “Inbound Custom Data Source Plugin Type”.

For Sandbox Users

When you have the components (plugin implementations and templates) ready after your modifications (if any) and verified to be working in your NetSuite sandbox (optional), you will be ready to use the components in your Builder Kit setup in your Production accounts.

If you have implemented and tested Builder kit components in Sandbox, store a copy of the plugin implementations, modified templates (if any), and related customizations, so that you can create/reuse it in Production.

For Non-Sandbox Users

You can implement the components similar to sandbox steps, and test with zero value or one cent invoices.

Sourcing custom data for e-documents

You can include custom data in generated e-documents, by implementing Custom Data Source plugin implementation in SuiteScript and use them in the E-Document Templates. Builder Kit provides sample PEPPOL custom data source plugin implementation that can be used as a reference.

                              return {
                customDataSources: [
                    {
                        format: render.DataSource.OBJECT,
                        alias: "avalara_cds",
                        data: {
                            mandate: mandate,
                            transaction: customObj,
                        },
                    },
                ],
                result: {
                    success: true,
                    eiAuditTrailMsg: "", //EI puts a default message if the CDS is returned successfully
                },
            }; 

                

Modifying Template Mapping

Adding tags, and mapping additional values returned from Outbound CDS plugin implementation.

After the E-Document Templates are created using builder kit, you may modify the outbound template by editing the Template for Outbound E-documents field in the E-Document Template.

You can add additional XML tags that reference data returned by Custom data source Plugin Implementation type set in Custom Data Source Plugin Implementation field of the same E-Document Template record.

Writing Avalara Message Process Plugin Type

To sync the status and related updates about an e-document after it is generated and sent, you will need to implement a custom plugin of type “Avalara Message Process Plugin Type”.

• Appendix: Sample Avalara Message Process plugin type implementation.

  You can see a sample plugin implementation by navigating to:

  Documents > File > File Cabinet > SuiteBundles > Bundle 436209 > Sample Templates > Builder > Plugin Implementations > plugins > pl_peppol_starter_avalara_doc_status.js

• Customizing the sample to add a value to custom transaction body field. The sample plugin implementation should implement function processRequestStatus

                      -   
  
  {Object} params
  -   {Object} params.transaction
  -   {Object} params.docStatusPayload { companyId, obnControlNumber id, events: "array<Event>", status, events[].message, events[].responseKey (optional)} 
  
                    

• Using Script execution logs for logging and debugging.

After customizing the plugin implementation stater to suit your needs, you can test your changes by generating e-documents with the templates. To help with debugging, N/log Module and log.debug(options) can be used.

The logs can be inspected under following script:

• Customization > Scripting > Scripts

• Set the filter to TYPE: RESTlet

• View script ID customscript_ei_update_transaction_rl

Ensure to set the Script Deployment to Log Level DEBUG, when using log.debug(options)