QuickBooks Source

This package models QuickBooks data from Fivetran's connector. It uses data in the format described by this ERD.

This package enriches your Fivetran data by doing the following:

• Adds descriptions to tables and columns that are synced using Fivetran
• Adds column-level testing where applicable. For example, all primary keys are tested for uniqueness and non-null values.
• Models staging tables, which will be used in our transform package

Models

This package contains staging models, designed to work simultaneously with our QuickBooks modeling package. The staging models name columns consistently across all packages:

• Boolean fields are prefixed with is_ or has_
• Timestamps are appended with _at
• ID primary keys are prefixed with the name of the table. For example, the account table's ID column is renamed to account_id.

Installation Instructions

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

Include in your packages.yml

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

Configuration

By default, this package looks for your QuickBooks data in the quickbooks schema of your target database. If this is not where your QuickBooks data is, add the following configuration to your dbt_project.yml file:

# dbt_project.yml

...
config-version: 2

vars:
    quickbooks_database: your_database_name
    quickbooks_schema: your_schema_name

Changing the Build Schema

By default this package will build the QuickBooks staging models within a schema titled (<target_schema> + _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:

# dbt_project.yml

...
models:
    quickbooks_source:
        +schema: my_new_schema_name

Disabling models

This package takes into consideration that not every QuickBooks account utilizes the same transactional tables, and allows you to disable the corresponding functionality. By default, most variables' values are assumed to be true (with exception of purchase orders). Add variables for only the tables you want to disable or enable respectively:

# dbt_project.yml

...
vars:
  quickbooks_source:
    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 invoices in QuickBooks
    using_invoice_bundle: false         #disable if you don't have invoice bundles in QuickBooks
    using_journal_entry:  false         #disable if you don't have journal entries in QuickBooks
    using_payment:        false         #disable if you don't have payments in QuickBooks
    using_refund_receipt: false         #disable if you don't have refund receipts in QuickBooks
    using_transfer:       false         #disable if you don't have transfers in QuickBooks
    using_vendor_credit:  false         #disable if you don't have vendor credits in QuickBooks
    using_sales_receipt:  false         #disable if you don't have sales receipts in QuickBooks
    using_purchase_order: true          #enable if you want to include purchase orders in your staging models

Contributions

Additional contributions to this package are very welcome! Please create issues or open PRs against main. Check out this post on the best workflow for contributing to a package.

Resources:

• Provide feedback on our existing dbt packages or what you'd like to see next
• Have questions or feedback, or need help? Book a time during our office hours here or shoot us an email at solutions@fivetran.com.
• Find all of Fivetran's pre-built dbt packages in our dbt hub
• Learn how to orchestrate dbt transformations with Fivetran here.
• Learn more about Fivetran overall in our docs
• Check out Fivetran's blog
• Learn more about dbt in the dbt docs
• Check out Discourse for commonly asked questions and answers
• Join the chat on Slack for live discussions and support
• Find dbt events near you
• Check out the dbt blog for the latest news on dbt's development and best practices