Releases: fivetran/dbt_xero
Releases · fivetran/dbt_xero
v1.3.0 dbt_xero
PR #72 includes the following updates:
Schema Changes
2 total changes • 1 possible breaking change
| Data Model | Change type | Old | New | Notes |
|---|---|---|---|---|
xero__invoice_line_items |
New Column | contact_id |
ID of the associated CONTACT. |
|
| All models | Single-connection source_relation value |
Empty string ('') |
<xero_database>.<xero_schema> |
Feature Update
- Introduces support for the newer, more flexible unioning framework. Previously, to run the package on multiple Xero sources at once, you could only use the
union_schemasvariable ORunion_databases(mutually exclusive). While these setups are still supported for backwards compatibility, we recommend usingxero_sourcesinstead, which can be configured as such:
# dbt_project.yml
vars:
xero:
xero_sources:
- database: connection_1_destination_name # Required
schema: connection_1_schema_name # Required
name: connection_1_source_name # Required only if following this step: https://github.com/fivetran/dbt_xero/blob/main/README.md#recommended-incorporate-unioned-sources-into-dag
- database: connection_2_destination_name
schema: connection_2_schema_name
name: connection_2_source_name- See the README for more details.
Full Changelog: v1.2.0...v1.3.0
v1.2.0 dbt_xero
PR #70 includes the following updates:
Documentation
- Updates README with standardized Fivetran formatting.
Under the Hood
- In the
quickstart.ymlfile:- Adds
table_variablesfor relevant sources to prevent missing sources from blocking downstream Quickstart models. - Adds
supported_varsfor Quickstart UI customization.
- Adds
Full Changelog: v1.1.1...v1.2.0
v1.1.1 dbt_xero
PR #67 includes the following updates:
Bug Fix
- Resolves naming conflicts in models with dynamically pivoted tracking category columns. When a pivoted column name matches an existing column, the model automatically adds a
pivoted_prefix. Applies to:xero__general_ledgerxero__invoice_line_itemsxero__profit_and_loss_report
Under the Hood
- Renames the
get_prefixed_tracking_category_columnsmacro toget_pivoted_tracking_category_columnsand simplifies it to return only base column names, improving maintainability and readability. - Updates seed data to cover a wider range of tracking category scenarios.
Full Changelog: v1.1.0...v1.1.1
v1.1.0 dbt_xero
PR #69 includes the following updates:
Features
- Increases the required dbt version upper limit to v3.0.0
Full Changelog: v1.0.1...v1.1.0
v1.0.1 dbt_xero
PR #68 includes the following updates:
Feature Update
- Added optional
xero__calendar_start_datevariable to allow users to customize the start date for the calendar spine model. The variable defaults to2019-01-01, maintaining backward compatibility with existing implementations.
Under the Hood
- Updated
vertical_general_ledger_trackingvalidation test to filter ontracking_option_name, which was renamed foroption.
Documentation
- Updated README to include instructions for configuring the new
xero__calendar_start_datevariable.
Full Changelog: v1.0.0...v1.0.1
v1.0.0 dbt_xero
PR #64 includes the following updates:
Breaking Changes
Source Package Consolidation
- Removed the dependency on the
fivetran/xero_sourcepackage.- All functionality from the source package has been merged into this transformation package for improved maintainability and clarity.
- If you reference
fivetran/xero_sourcein yourpackages.yml, you must remove this dependency to avoid conflicts. - Any source overrides referencing the
fivetran/xero_sourcepackage will also need to be removed or updated to reference this package. - Update any xero_source-scoped variables to be scoped to only under this package. See the README for how to configure the build schema of staging models.
- As part of the consolidation, vars are no longer used to reference staging models, and only sources are represented by vars. Staging models are now referenced directly with
ref()in downstream models.
dbt Fusion Compatibility Updates
- Updated package to maintain compatibility with dbt-core versions both before and after v1.10.6, which introduced a breaking change to multi-argument test syntax (e.g.,
unique_combination_of_columns). - Temporarily removed unsupported tests to avoid errors and ensure smoother upgrades across different dbt-core versions. These tests will be reintroduced once a safe migration path is available.
- Removed all
dbt_utils.unique_combination_of_columnstests. - Moved
loaded_at_field: _fivetran_syncedunder theconfig:block insrc_xero.yml.
- Removed all
Under the Hood
- Updated conditions in
.github/workflows/auto-release.yml. - Added
.github/workflows/generate-docs.yml.
Full Changelog: v0.9.0...v1.0.0
v0.9.0 dbt_xero
This release includes the following updates:
Breaking Changes
- Added tracking categories by pivoting out fields and grabbing the latest tracking category records from invoice line items and journal line entries. This update will provide more granular reporting capabilities and will result in the following model changes: (PR #60)
xero__general_ledgerdynamically pivots out journal line tracking category names and populates each line with the active options for the categories for these journals and accounts.xero__profit_and_loss_reportwill see a change in the grain with these new dynamic pivoted tracking categories added to each journal line.- Added these dynamic tracking categories to the
profit_and_loss_idas they are now unique lines within the profit and loss. IMPORTANT: This will change the existing values of theprofit_and_loss_id, so this is a breaking change. (PR #60)
- Added these dynamic tracking categories to the
xero__invoice_line_itemsdynamically pivots out invoice line item tracking category and populates each line with the active options for those line items.
- Created intermediate models
int_xero__invoice_line_item_tracking_categoriesandint_xero__journal_line_tracking_categoriesto perform thedbt_utilspivot operations. (PR #60) - Added the following variables to allow the ability to disable your models if you're not planning to utilize the tracking category configuration. See the README for detailed instructions. (PR #60)
xero__using_invoice_line_item_tracking_categoryxero__using_journal_line_tracking_categoryxero__using_tracking_categories
- These variables are utilized in the following end models:
| End Models Impacted | Variables Implemented |
|---|---|
xero__general_ledger, xero__profit_and_loss_report |
xero__using_journal_line_tracking_category, xero__using_tracking_categories |
xero__invoice_line_items |
xero__using_invoice_line_item_tracking_category, xero__using_tracking_categories |
Under the Hood
- Added new table variables in
quickstart.ymlto ensure their respective models are enabled and disabled appropriately. (PR #60) - Created
get_prefixed_tracking_category_columnsmacro to properly bring in and check for pivoted columns within the abovedbt_xeroend models. - Created integrity tests to ensure tracking category values for journal lines and invoice items match between the above end models and their source tables. (PR #60)
- Added and updated seed files to properly test out advanced cases for the new tracking categories. (PR #60)
Documentation
- Added instructions in the README for how to disable tracking category functionality utilizing the new variables. (PR #60)
- Updated README to better elaborate on why multi-currency can't be fully supported by our dbt package. (PR #61)
Full Changelog: v0.8.0...v0.9.0
v0.8.0 dbt_xero
PR #54 includes the following updates:
Bug Fixes
- Fixed the
_credit_noteand_bank_transactiontable variable naming inquickstart.ymlto ensure their respective models are enabled and disabled appropriately. - We've made this release a breaking change to highlight to all Quickstart customers that this will have an impact on their model counts if either of these tables are selected in the schema tab and present in their destination.
Full Changelog: v0.7.0...v0.8.0
v0.7.0 dbt_xero
PR #54 includes the following updates:
Breaking Changes
- Corrected the calculation of
current_year_end_datein thexero__balance_sheet_reportmodel. Previously,current_year_end_datewas miscalculated in certain scenarios, impacting the classification of records with theaccount_namevalue "Retained Earnings."- This is labeled as a breaking change since it may affect prior labels assigned. We recommend reviewing your records to ensure they align with this corrected logic.
Bug Fixes
- Updated the
xero__balance_sheetmodel to resolve a run error when an organization's financial year end date is February 29.
Documentation
- Updated README formatting for consistency with other packages.
- Added Quickstart model counts to README. (#52)
- Corrected references to connectors and connections in the README. (#52)
Under the Hood (maintainers only)
- Added consistency tests for the end models.
Full Changelog: v0.6.2...v0.7.0
v0.6.2 dbt_xero
PR #46 includes the following updates:
Bug Fixes
- Update to the
xero__balance_sheetmodel to ensure the calculatedcurrent_year_end_datefield takes into account fiscal year ends which occur in a leap year. To address this, if a lookback is required, then February 28th of the previous year will be used to ensure a valid date is used.
Under the Hood
- Included auto-releaser GitHub Actions workflow to automate future releases.
- Updated the maintainer PR template to resemble the most up to date format.
Full Changelog: v0.6.1...v0.6.2