Netsuite Transformation dbt Package (Docs)

📣 What does this dbt package do?

• Produces modeled tables that leverage Netsuite ODBC data and builds off the output of our Netsuite source package.
• Enables users to insights into their netsuite data that can be used for financial statement reporting and deeper transactional analysis. This is achieved by the following:
  • Recreating both the balance sheet and income statement
  • Recreating commonly used data by using the transaction lines as the base table and joining other data
• Generates a comprehensive data dictionary of your source and modeled Netsuite data through the dbt docs site.

The following table provides a detailed list of all models materialized within this package by default.

TIP: See more details about these models in the package's dbt docs site.

Model	Description
netsuite__transaction_details	All transactions with the associated accounting period, account and subsidiary information. Where applicable, you can also see data about the customer, location, item, vendor, and department.
netsuite__income_statement	All transaction lines necessary to generate an income statement (converted for the appropriate exchange rate of the parent subsidiary). Department, class, and location information are included for additional reporting functionality.
netsuite__balance_sheet	All transaction lines necessary to generate a balance sheet (converted for the appropriate exchange rate of the parent subsidiary). Non balance sheet transactions are categorized as either Retained Earnings or Net Income.

🎯 How do I use the dbt package?

Step 1: Prerequisites

To use this dbt package, you must have the Netsuite2 (netsuite2.com) ODBC connector syncing the respective tables to your destination:

Netsuite2.com (ODBC)

• account
• accounttype
• accountingbooksubsidiary
• accountingperiodfiscalcalendar
• accountingperiod
• accountingbook
• classification
• currency
• customer
• department
• employee
• employeestatus
• employeestatuscategory
• employeetype
• employeetypecategory
• entity
• entityaddress
• item
• itemsubtype
• itemtype
• location
• locationmainaddress
• subsidiary
• transaction
• transactionaccountingline
• transactionline
• transactionstatus
• vendor
• vendorcategory

Database Compatibility

This package is compatible with either a BigQuery, Snowflake, Redshift, PostgreSQL, or Databricks destination.

Databricks dispatch configuration

If you are using a Databricks destination with this package, you must add the following (or a variation of the following) dispatch configuration within your dbt_project.yml. This is required in order for the package to accurately search for macros within the dbt-labs/spark_utils then the dbt-labs/dbt_utils packages respectively.

dispatch:
  - macro_namespace: dbt_utils
    search_order: ['spark_utils', 'dbt_utils']

Step 2: Install the package

Include the following netsuite package version in your packages.yml file:

TIP: Check dbt Hub for the latest installation instructions or read the dbt docs for more information on installing packages.

packages:
  - git: "https://github.com/swishbi/dbt_netsuite.git"
    revision: v0.X.X # See latest version in releases

Step 3: Define database and schema variables

By default, this package runs using your destination and the netsuite schema. If this is not where your Netsuite data is (for example, if your netsuite schema is named netsuite_source), add the following configuration to your root dbt_project.yml file:

vars:
    netsuite_database: your_destination_name
    netsuite_schema: your_schema_name 

Step 4: Enable models for non-existent sources

It's possible that your Netsuite connector does not sync every table that this package expects. If your syncs exclude certain tables, it is because you either don't use that feature in Netsuite or actively excluded some tables from your syncs. To disable the corresponding functionality in the package, you must add the relevant variables. By default, all variables are assumed to be false. Add variables for only the tables you would like to enable:

vars:
  netsuite_source:
    netsuite__advanced_billing_enabled: true # Enable `billingschedulemilestone`, `billingscheduletype`, and `billingschedule` if you are using the Advanced Billing featre
    netsuite__advanced_jobs_enabled: true # Enable `jobresources`, `projecttask` and `projecttaskassigneee` if you are using the Advanced Jobs feature
    netsuite__advanced_revenue_management_enabled: true # Enable `billingrevenueevent`, `billingschedulerecurrence`, `revenueelement`, `revenueplanplannedcost`, `revenueplanplannedrevenue`, `revenueplanstatus`, revenueplantype`, and `revenueplan` if you are using the Advanced Revenue Management feature
    netsuite__multibook_accounting_enabled: true # Enable `accountingbooksubsidiary` and `accountingbook` if you are using the Multi-Book Accounting feature
    netsuite__multiple_budgets_enabled: true # Enable `budgetcategory` if you are using the Multiple Budgets feature
    netsuite__multiple_calendars_enabled: true # Enable `accountingperiodfiscalcalendar` if you are using the Multiple Calendars feature
    netsuite__multiple_currencies_enabled: true # Enable `currency` and `consolidatedexchangerate` if you are using the Multiple Currencies feature
    netsuite__planned_work_enabled: true # Enable `plannedwork` in `projecttask` and `projecttaskassignee` if you are using the Planned Work feature
    netsuite__team_selling_enabled: true # Enable `transactionsalesteam` if you are using the Team Selling feature
    netsuite__time_off_management_enabled: true # Enable `timeofftype`, `workcalendar`, and `workcalendarholiday` if you are using the Time Off Management feature
    netsuite__time_tracking_enabled: true # Enable `timebill` if you are using the Time Tracking feature
    netsuite__using_budgets: true # Enable `budget`, `budgetcategory`, and `budgetsmachine` if you use budgets
    netsuite__using_customer_categories: true # Enable `customercategory` if you categorize your customers
    netsuite__using_vendor_categories: true # Enable `vendorcategory` if you categorize your vendors
    netsuite__using_jobs: true # Enable `job`, `jobstatus`, and `jobtype` if you use jobs

Note: To determine if a table or field is activated by a feature, access the Records Catalog.

(Optional) Step 6: Additional configurations

Expand for configurations

Passing Through Additional Fields

This package includes all source columns defined in the macros folder. To add additional columns to this package, do so by adding our pass-through column variables to your dbt_project.yml file:

vars:
    accounts_pass_through_columns: 
        - name: "new_custom_field"
          alias: "custom_field"
    classes_pass_through_columns: 
        - name: "this_field"
    departments_pass_through_columns: 
        - name: "unique_string_field"
          alias: "field_id"
          transform_sql: "cast(field_id as string)"
    transactions_pass_through_columns: 
        - name: "that_field"
    transaction_lines_pass_through_columns: 
        - name: "other_id"
          alias: "another_id"
          transform_sql: "cast(another_id as int64)"
    customers_pass_through_columns: 
        - name: "customer_custom_field"
          alias: "customer_field"
    locations_pass_through_columns: 
        - name: "location_custom_field"
    subsidiaries_pass_through_columns: 
        - name: "sub_field"
          alias: "subsidiary_field"
    consolidated_exchange_rates_pass_through_columns: 
        - name: "consolidate_this_field"

Passing Through Transaction Detail Fields

Additionally, this package allows users to pass columns from the netsuite__transaction_details table into the netsuite__balance_sheet and netsuite__income_statement tables. See below for an example of how to passthrough transaction detail columns into the respective balance sheet and income statement final tables within your dbt_project.yml file.

vars:
    balance_sheet_transaction_detail_columns: ['company_name','vendor_name']
    income_statement_transaction_detail_columns: ['is_account_intercompany','location_name']

Change the build schema

By default, this package builds the Netsuite staging models within a schema titled (<target_schema> + _netsuite_source) and your Netsuite modeling models within a schema titled (<target_schema> + _netsuite) in your destination. If this is not where you would like your Netsuite data to be written to, add the following configuration to your root dbt_project.yml file:

models:
    netsuite_source:
      +schema: my_new_schema_name # leave blank for just the target_schema
    netsuite:
      +schema: my_new_schema_name # leave blank for just the target_schema

Change the source table references

If an individual source table has a different name than the package expects, add the table name as it appears in your destination to the respective variable:

IMPORTANT: See this project's dbt_project.yml variable declarations to see the expected names.

vars:
    netsuite_<default_source_table_name>_identifier: your_table_name 

🔍 Does this package have dependencies?

This dbt package is dependent on the following dbt packages. Please be aware that these dependencies are installed by default within this package. For more information on the following packages, refer to the dbt hub site.

IMPORTANT: If you have any of these dependent packages in your own packages.yml file, we highly recommend that you remove them from your root packages.yml to avoid package version conflicts.

packages:
    - git: "https://github.com/swishbi/dbt_netsuite_source.git"
      revision: v0.2.0

    - package: fivetran/fivetran_utils
      version: [">=0.4.0", "<0.5.0"]

    - package: dbt-labs/dbt_utils
      version: [">=1.0.0", "<2.0.0"]

    - package: dbt-labs/spark_utils
      version: [">=0.3.0", "<0.4.0"]

🙌 How is this package maintained and can I contribute?

Package Maintenance

The Swish BI team maintaining this package only maintains the latest version of the package. We highly recommend that you stay consistent with the latest version of the package and refer to the CHANGELOG and release notes for more information on changes across versions.

Contributions

The Swish BI team develops these dbt packages. However, the packages are made better by community contributions!

We highly encourage and welcome contributions to this package. Check out this dbt Discourse article to learn how to contribute to a dbt package!

🏪 Are there any resources available?

• If you have questions or want to reach out for help, please refer to the GitHub Issue section to find the right avenue of support for you.
• If you would like to provide feedback to the dbt package team at Swish BI or would like to request a new dbt package, fill out our Feedback Form.