151bb46182
# Description Creates a seed to define how to aggregate the different revenue/cost sources, at account code level. This is propagated to the sales denom mart in intermediate. This is not complete, but should be a good starting point and it enables moving forward with a couple of tickets regarding KPIs revenue refactor and further Finance reporting, by just keeping a single source of truth. It's mostly focusing on the Don't Repeat Yourself # Checklist - [X] The edited models and dependants run properly with production data. - [X] The edited models are sufficiently documented. - [X] The edited models contain PK tests, and I've ran and passed them. - [X] I have checked for DRY opportunities with other models and docs. - [X] I've picked the right materialization for the affected models. # Other - [ ] Check if a full-refresh is required after this PR is merged. First version of accounting aggregations - not complete Related work items: #26618
277 lines
7.1 KiB
YAML
277 lines
7.1 KiB
YAML
version: 2
|
|
|
|
models:
|
|
- name: int_xero__invoices
|
|
columns:
|
|
- name: id_invoice
|
|
data_tests:
|
|
- not_null
|
|
- unique
|
|
- name: int_xero__credit_notes
|
|
columns:
|
|
- name: id_credit_note
|
|
data_tests:
|
|
- not_null
|
|
- unique
|
|
- name: int_xero__invoice_line_items
|
|
columns:
|
|
- name: id_line_item
|
|
data_tests:
|
|
- not_null
|
|
- unique
|
|
- name: int_xero__credit_note_line_items
|
|
columns:
|
|
- name: id_line_item
|
|
data_tests:
|
|
- not_null
|
|
- unique
|
|
- name: int_xero__bank_transactions
|
|
columns:
|
|
- name: id_bank_transaction
|
|
data_tests:
|
|
- not_null
|
|
- unique
|
|
|
|
- name: int_xero__sales_denom_mart
|
|
description: |
|
|
This table is a denormalized mix of all invoices and credit notes data.
|
|
|
|
It is built by creating a snowflake schema for the invoicing area and
|
|
another one for the crediting area. In both cases, the cardinality is
|
|
*:1 between line items and documents, and *:1 between documents and
|
|
contacts. Then, the invoice and credit note side get unioned to be stored
|
|
in a single structure. The only transformation that happens differently
|
|
across both is that credit note amounts get their sign reversed (* -1) so
|
|
that aggregations happen naturally (credit amounts subtract from invoice
|
|
amounts). The final granularity of the table is on the line item level.
|
|
Invoice and credit note records can be told apart through the
|
|
document_class field.
|
|
|
|
The word _document_ in the context of this table encompasses both invoices
|
|
and credit notes.
|
|
|
|
The source of amounts is identifiable by their prefix. `line_` amount
|
|
fields come from the line items data, while `header_` fields come from the
|
|
document level data. Aggregating line fields can be done without worries.
|
|
Document level data can't be summed or averaged since it's duplicated per
|
|
line item, so be careful with it.
|
|
|
|
Fields are not documented here: you can find more details in upstream
|
|
models.
|
|
|
|
columns:
|
|
- name: id_line_item
|
|
data_type: text
|
|
description: ""
|
|
data_tests:
|
|
- not_null
|
|
- unique
|
|
|
|
- name: id_item
|
|
data_type: text
|
|
description: ""
|
|
|
|
- name: document_class
|
|
data_type: text
|
|
description: |
|
|
Indicates whether the record belongs in an invoice or a credit note.
|
|
data_tests:
|
|
- not_null
|
|
- accepted_values:
|
|
values:
|
|
- "invoice"
|
|
- "credit note"
|
|
|
|
- name: id_account
|
|
data_type: text
|
|
description: ""
|
|
|
|
- name: account_code
|
|
data_type: text
|
|
description: ""
|
|
|
|
- name: account_name
|
|
data_type: text
|
|
description: ""
|
|
|
|
- name: item_code
|
|
data_type: text
|
|
description: ""
|
|
|
|
- name: quantity
|
|
data_type: numeric
|
|
description: ""
|
|
|
|
- name: unit_amount
|
|
data_type: numeric
|
|
description: ""
|
|
|
|
- name: line_amount_local_curr
|
|
data_type: numeric
|
|
description: ""
|
|
|
|
- name: line_amount_in_gbp
|
|
data_type: numeric
|
|
description: ""
|
|
|
|
- name: line_amount_wo_taxes_local_curr
|
|
data_type: numeric
|
|
description: ""
|
|
|
|
- name: line_amount_wo_taxes_in_gbp
|
|
data_type: numeric
|
|
description: ""
|
|
|
|
- name: tax_amount_local_curr
|
|
data_type: numeric
|
|
description: ""
|
|
|
|
- name: tax_amount_in_gbp
|
|
data_type: numeric
|
|
description: ""
|
|
|
|
- name: tax_type
|
|
data_type: text
|
|
description: ""
|
|
|
|
- name: document_currency_iso_4217
|
|
data_type: character varying
|
|
description: ""
|
|
data_tests:
|
|
- not_null
|
|
- length_between:
|
|
min_length: 3
|
|
max_length: 3
|
|
|
|
- name: line_description
|
|
data_type: text
|
|
description: ""
|
|
|
|
- name: id_document
|
|
data_type: character varying
|
|
description: ""
|
|
data_tests:
|
|
- not_null
|
|
|
|
- name: reference
|
|
data_type: character varying
|
|
description: ""
|
|
|
|
- name: document_number
|
|
data_type: character varying
|
|
description: ""
|
|
|
|
- name: document_issued_at_utc
|
|
data_type: timestamp with time zone
|
|
description: ""
|
|
|
|
- name: document_issued_date_utc
|
|
data_type: date
|
|
description: ""
|
|
|
|
- name: document_type
|
|
data_type: character varying
|
|
description: ""
|
|
data_tests:
|
|
- not_null
|
|
- accepted_values:
|
|
values:
|
|
- "ACCREC"
|
|
- "ACCPAY"
|
|
- "ACCRECCREDIT"
|
|
- "ACCPAYCREDIT"
|
|
|
|
- name: document_currency_iso_4217
|
|
data_type: character varying
|
|
description: ""
|
|
|
|
- name: exchange_rate_to_gbp
|
|
data_type: numeric
|
|
description: ""
|
|
data_tests:
|
|
- not_null
|
|
- not_negative
|
|
|
|
- name: document_status
|
|
data_type: character varying
|
|
description: ""
|
|
data_tests:
|
|
- not_null
|
|
- accepted_values:
|
|
values:
|
|
- PAID
|
|
- VOIDED
|
|
- DRAFT
|
|
- DELETED
|
|
- AUTHORISED
|
|
- SUBMITTED
|
|
|
|
- name: line_amount_tax_inclusiveness
|
|
data_type: character varying
|
|
description: ""
|
|
data_tests:
|
|
- accepted_values:
|
|
values:
|
|
- Inclusive
|
|
- Exclusive
|
|
- NoTax
|
|
|
|
- name: header_total_amount_local_curr
|
|
data_type: numeric
|
|
description: ""
|
|
|
|
- name: header_total_amount_in_gbp
|
|
data_type: numeric
|
|
description: ""
|
|
|
|
- name: header_total_amount_wo_tax_local_curr
|
|
data_type: numeric
|
|
description: ""
|
|
|
|
- name: header_total_amount_wo_tax_in_gbp
|
|
data_type: numeric
|
|
description: ""
|
|
|
|
- name: header_total_tax_local_curr
|
|
data_type: numeric
|
|
description: ""
|
|
|
|
- name: header_total_tax_in_gbp
|
|
data_type: numeric
|
|
description: ""
|
|
|
|
- name: header_total_due_local_curr
|
|
data_type: numeric
|
|
description: ""
|
|
|
|
- name: header_total_due_in_gbp
|
|
data_type: numeric
|
|
description: ""
|
|
|
|
- name: id_contact
|
|
data_type: character varying
|
|
description: ""
|
|
|
|
- name: id_deal
|
|
data_type: text
|
|
description: ""
|
|
|
|
- name: contact_name
|
|
data_type: character varying
|
|
description: ""
|
|
|
|
- name: accounting_root_aggregation
|
|
data_type: character varying
|
|
description: |
|
|
The root aggregation per account code. This is the main
|
|
aggregation that is used to retrieve low-level data.
|
|
|
|
- name: accounting_kpis_aggregation
|
|
data_type: character varying
|
|
description: |
|
|
The default macro-aggregation for Invoiced KPIs.
|
|
|
|
- name: accounting_financial_aggregation
|
|
data_type: character varying
|
|
description: |
|
|
The default macro-aggregation for Financial reporting.
|