search

fivetran / dbt_quickbooks_source

Data models for QuickBooks built using dbt.
https://fivetran.github.io/dbt_quickbooks_source/
Apache License 2.0
5 stars 18 forks source link
dbt dbt-packages fivetran fivetran-finance-reporting quickbooks

readme

QuickBooks Source dbt Package (Docs)

Table of Contents

What does this dbt package do?

How do I use the dbt package?

Step 1: Prerequisites

To use this dbt package, you must have the following:

Step 2: Install the package (skip if also using the quickbooks transformation package)

If you are not using the QuickBooks transformation package, include the following quickbooks_source 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:
  - package: fivetran/quickbooks_source
    version: [">=0.9.0", "<0.10.0"] # we recommend using ranges to capture non-breaking changes automatically

Step 3: Define database and schema variables

By default, this package runs using your destination and the quickbooks schema of your target database. If this is not where your QuickBooks data is (for example, if your QuickBooks schema is named quickbooks_fivetran), add the following configuration to your root dbt_project.yml file:

vars:
    quickbooks_database: your_destination_name
    quickbooks_schema: your_schema_name

Step 4: Enabling/Disabling Models

Your QuickBooks connector might not sync every table that this package expects. This package takes into consideration that not every QuickBooks account utilizes the same transactional tables.

By default, most variables' values are assumed to be true (with exception of using_purchase_order and using_credit_card_payment_txn). In other to enable or disable the relevant functionality in the package, you will need to add the relevant variables:

vars:
  using_address: false # disable if you don't have addresses in QuickBooks
  using_bill: false # disable if you don't have bills or bill payments in QuickBooks
  using_credit_memo: false # disable if you don't have credit memos in QuickBooks
  using_department: false # disable if you don't have departments in QuickBooks
  using_deposit: false # disable if you don't have deposits in QuickBooks
  using_estimate: false # disable if you don't have estimates in QuickBooks
  using_invoice: false # disable if you don't have estimates in QuickBooks
  using_invoice_bundle: false # disable if you don't have estimates in QuickBooks
  using_journal_entry: false # disable if you don't have estimates in QuickBooks
  using_payment: false # disable if you don't have estimates in QuickBooks
  using_refund_receipt: false # disable if you don't have estimates in QuickBooks
  using_transfer: false # disable if you don't have estimates in QuickBooks
  using_vendor_credit: false # disable if you don't have estimates in QuickBooks
  using_sales_receipt: false # disable if you don't have estimates in QuickBooks
  using_purchase_order: true # enable if you want to include purchase orders in your staging models
  using_credit_card_payment_txn: true # enable if you want to include credit card payment transactions in your staging models

(Optional) Step 5: Additional Configurations

Expand for configurations #### Unioning Multiple QuickBooks Connectors If you have multiple QuickBooks connectors in Fivetran and would like to use this package on all of them simultaneously, we have provided functionality to do so. The package will union all of the data together and pass the unioned table into the transformations. You will be able to see which source it came from in the `source_relation` column of each model. To use this functionality, you will need to set **either** (**note that you cannot use both**) the `quickbooks_union_schemas` or `quickbooks_union_databases` variables: ```yml # dbt_project.yml ... config-version: 2 vars: quickbooks_union_schemas: ['quickbooks_us','quickbooks_ca'] # use this if the data is in different schemas/datasets of the same database/project quickbooks_union_databases: ['quickbooks_us','quickbooks_ca'] # use this if the data is in different databases/projects but uses the same schema name ``` #### Changing the Build Schema By default this package will build the QuickBooks staging models within a schema titled ( + `_quickbooks_staging`) in your target database. If this is not where you would like you QuickBooks staging data to be written to, add the following configuration to your `dbt_project.yml` file: ```yml # dbt_project.yml ... models: quickbooks_source: +schema: my_new_schema_name ``` #### 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`](https://github.com/fivetran/dbt_quickbooks_source/blob/main/dbt_project.yml) variable declarations to see the expected names. ```yml vars: quickbooks__identifier: your_table_name ```

(Optional) Step 6: Orchestrate your models with Fivetran Transformations for dbt Core™

Expand for details
Fivetran offers the ability for you to orchestrate your dbt project through [Fivetran Transformations for dbt Core™](https://fivetran.com/docs/transformations/dbt). Learn how to set up your project for orchestration through Fivetran in our [Transformations for dbt Core setup guides](https://fivetran.com/docs/transformations/dbt#setupguide).

Does this package have dependencies?

This dbt package is dependent on the following dbt packages. 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:
    - package: fivetran/fivetran_utils
      version: [">=0.4.0", "<0.5.0"]

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

How is this package maintained and can I contribute?

Package Maintenance

The Fivetran 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

A small team of analytics engineers at Fivetran 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?