Merge pull request #98 from fivetran/bugfix/set-account-type-variables

[Bugfix] New variables to configure account type value filters
fivetran · Aug 7, 2023 · fc17b5e · fc17b5e
2 parents 5fe28a4 + b08a30e
commit fc17b5e
Show file tree

Hide file tree

Showing 15 changed files with 55 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,27 @@
+# dbt_quickbooks v0.11.1
+This PR includes the following updates:
+
+## 🐛 Bug Fixes 🩹
+- Updated intermediate double entry models that have `account_type` and `account_sub_type` filters with configurable variables, since the type names used in the filter can be adjusted internally by QuickBooks customers. ([PR #98](https://github.com/fivetran/dbt_quickbooks/pull/98))
+- Includes `items.asset_account_id` as the second field of the coalesce for the `payed_to_account_id` field within the `int_quickbooks__bill_payment_double_entry` model to ensure all account_id types are taken into consideration when mapping the transaction to the proper account. ([PR #100](https://github.com/fivetran/dbt_quickbooks/pull/100))
+
+## 🎉 Feature Updates 🎉
+- The intermediate models where these variables were introduced in the models below:
+
+| **Updated model** | **New variables to filter on** |
+| ----------| -------------------- |
+| [int_quickbooks__bill_payment_double_entry](https://fivetran.github.io/dbt_quickbooks/#!/model/model.quickbooks.int_quickbooks__bill_payment_double_entry) | `quickbooks__accounts_payable_reference` |
+| [int_quickbooks__credit_memo_double_entry](https://fivetran.github.io/dbt_quickbooks/#!/model/model.quickbooks.int_quickbooks__credit_memo_double_entry) | `quickbooks__accounts_receivable_reference` |
+| [int_quickbooks__deposit_double_entry](https://fivetran.github.io/dbt_quickbooks/#!/model/model.quickbooks.int_quickbooks__deposit_double_entry) | `quickbooks__undeposited_funds_reference` |
+| [int_quickbooks__invoice_double_entry](https://fivetran.github.io/dbt_quickbooks/#!/model/model.quickbooks.int_quickbooks__invoice_double_entry) | `quickbooks__sales_of_product_income_reference`, `quickbooks__accounts_receivable_reference` |
+| [int_quickbooks__payment_double_entry](https://fivetran.github.io/dbt_quickbooks/#!/model/model.quickbooks.int_quickbooks__payment_double_entry) | `quickbooks__accounts_receivable_reference` |
+
+## 🗒️ Documentation
+- [Updated README with additional steps for configuration](https://github.com/fivetran/dbt_quickbooks/blob/main/README.md#optional-step-5-additional-configurations). This is an optional step since most customers will rely on the default account type/subtype values available.
+
+## Contributors
+- [@mikerenderco](https://github.com/mikerenderco) ([PR #100](https://github.com/fivetran/dbt_quickbooks/pull/100))
+
 # dbt_quickbooks v0.11.0
 ## 🚨 Breaking Changes 🚨
 [PR #95](https://github.com/fivetran/dbt_quickbooks/pull/95) includes the following updates:

diff --git a/README.md b/README.md
@@ -128,6 +128,19 @@ vars:
     quickbooks_union_databases: ['quickbooks_usa','quickbooks_canada'] # use this if the data is in different databases/projects but uses the same schema name
 ``` 
 
+### Configuring Account Type Names
+Within a few of the double entry models in this package a mapping takes place to assign certain transaction type's debits/credits to the appropriate offset account (ie. Accounts Payable, Accounts Receivable, Undeposited Funds, and SalesOfProductIncome) reference. While our current filtered logic within our intermediate models account for the default values, it's possible your use case relies on different account types to reference. 
+
+If you have a different value to reference for each type, you will need to configure the `account_type` and `account_sub_type` variables that account for these variables in your `dbt_project.yml`.
+
+```yml
+vars: 
+  quickbooks__accounts_payable_reference: accounts_payable_value # 'Accounts Payable' is the default filter set for the account_type reference.
+  quickbooks__accounts_receivable_reference: account_receivable_value # 'Accounts Receivable' is the default filter set for the account_type reference.
+  quickbooks__undeposited_funds_reference: account_undeposited_funds_value # 'UndepositedFunds' is the default filter set for the account_subtype reference.
+  quickbooks__sales_of_product_income_reference: account_sales_of_product_income_value # 'SalesOfProductIncome' is the default filter set for the account_subtype reference.
+```
+
 ### Customize the Cash Flow Model 
 **IMPORTANT**: It is very likely you will need to reconfigure your `cash_flow_type` to make sure your cash flow statement matches your specific use case. Please examine the following instructions.
 

diff --git a/dbt_project.yml b/dbt_project.yml
@@ -1,7 +1,7 @@
 config-version: 2
 name: 'quickbooks'
 
-version: '0.11.0'
+version: '0.11.1'
 
 require-dbt-version: [">=1.3.0", "<2.0.0"]
 

diff --git a/docs/catalog.json b/docs/catalog.json
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/manifest.json b/docs/manifest.json
diff --git a/docs/run_results.json b/docs/run_results.json
diff --git a/integration_tests/.gitignore b/integration_tests/.gitignore
@@ -1,4 +1,5 @@
 target/
 dbt_modules/
 dbt_packages/
-logs/
+logs/
+env/
diff --git a/integration_tests/dbt_project.yml b/integration_tests/dbt_project.yml
@@ -1,6 +1,6 @@
 name: 'quickbooks_integration_tests'
 
-version: '0.11.0'
+version: '0.11.1'
 
 profile: 'integration_tests'
 config-version: 2

diff --git a/models/double_entry_transactions/int_quickbooks__bill_double_entry.sql b/models/double_entry_transactions/int_quickbooks__bill_double_entry.sql
@@ -37,7 +37,7 @@ bill_join as (
         bill_lines.index,
         bills.transaction_date,
         bill_lines.amount,
-        coalesce(bill_lines.account_expense_account_id, items.expense_account_id, items.parent_expense_account_id, items.expense_account_id, items.parent_income_account_id, items.income_account_id) as payed_to_account_id,
+        coalesce(bill_lines.account_expense_account_id,items.asset_account_id, items.expense_account_id, items.parent_expense_account_id, items.expense_account_id, items.parent_income_account_id, items.income_account_id) as payed_to_account_id,
         bills.payable_account_id,
         coalesce(bill_lines.account_expense_customer_id, bill_lines.item_expense_customer_id) as customer_id,
         coalesce(bill_lines.item_expense_class_id, bill_lines.account_expense_class_id) as class_id,

diff --git a/models/double_entry_transactions/int_quickbooks__bill_payment_double_entry.sql b/models/double_entry_transactions/int_quickbooks__bill_payment_double_entry.sql
@@ -30,12 +30,13 @@ ap_accounts as (
         source_relation
     from accounts
 
-    where account_type = 'Accounts Payable'
+    where account_type = '{{ var('quickbooks__accounts_payable_reference', 'Accounts Payable') }}'
         and is_active
         and not is_sub_account
 ),
 
 bill_payment_join as (
+
     select
         bill_payments.bill_payment_id as transaction_id,
         bill_payments.source_relation,
@@ -51,7 +52,6 @@ bill_payment_join as (
 
     inner join ap_accounts
     on ap_accounts.source_relation = bill_payments.source_relation
-
 ),
 
 final as (

diff --git a/models/double_entry_transactions/int_quickbooks__credit_memo_double_entry.sql b/models/double_entry_transactions/int_quickbooks__credit_memo_double_entry.sql
@@ -36,7 +36,7 @@ df_accounts as (
         source_relation
     from accounts
 
-    where account_type = 'Accounts Receivable'
+    where account_type = '{{ var('quickbooks__accounts_receivable_reference', 'Accounts Receivable') }}'
         and is_active
         and not is_sub_account
 ),

diff --git a/models/double_entry_transactions/int_quickbooks__deposit_double_entry.sql b/models/double_entry_transactions/int_quickbooks__deposit_double_entry.sql
@@ -31,7 +31,7 @@ uf_accounts as (
         source_relation
     from accounts
 
-    where account_sub_type = 'UndepositedFunds'
+    where account_sub_type = '{{ var('quickbooks__undeposited_funds_reference', 'UndepositedFunds') }}'
         and is_active
         and not is_sub_account
 ),

diff --git a/models/double_entry_transactions/int_quickbooks__invoice_double_entry.sql b/models/double_entry_transactions/int_quickbooks__invoice_double_entry.sql
@@ -57,7 +57,7 @@ income_accounts as (
     select *
     from accounts
 
-    where account_sub_type = 'SalesOfProductIncome'
+    where account_sub_type = '{{ var('quickbooks__sales_of_product_income_reference', 'SalesOfProductIncome') }}'
 ),
 
 bundle_income_accounts as (
@@ -90,7 +90,7 @@ ar_accounts as (
         source_relation
     from accounts
 
-    where account_type = 'Accounts Receivable'
+    where account_type = '{{ var('quickbooks__accounts_receivable_reference', 'Accounts Receivable') }}'
 ),
 
 invoice_join as (

diff --git a/models/double_entry_transactions/int_quickbooks__payment_double_entry.sql b/models/double_entry_transactions/int_quickbooks__payment_double_entry.sql
@@ -30,7 +30,7 @@ ar_accounts as (
         source_relation
     from accounts
 
-    where account_type = 'Accounts Receivable'
+    where account_type = '{{ var('quickbooks__accounts_receivable_reference', 'Accounts Receivable') }}'
         and is_active
         and not is_sub_account
 ),