counterweight/data-dwh-dbt-project
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs formatting

Browse source
This commit is contained in:
Pablo Martin 2024-05-16 16:22:41 +02:00
parent 9068774f35
commit 08ea22eee9
1 changed files with 80 additions and 66 deletions
Download patch file Download diff file Expand all files Collapse all files

146
models/reporting/xero/schema.yaml
View file

@ -284,14 +284,13 @@ models:
- name: id_deal
data_type: text
description: |
description: |
For those account numbers that look like a Deal Id, we extract them
into this field. Other contacs will have a blank.
You can use this to find specific deal ids or even as a proxy bool to
keep or remove deal id customers.
- name: contact_name
data_type: character varying
description: The name for the customer.
@ -396,7 +395,7 @@ models:
data_type: character varying
description: |
The default currency used to interact with this contact.
For customers, this is the currency we will usually use to invoice.
- name: validation_errors
@ -484,8 +483,8 @@ models:
- name: line_amount_local_curr
data_type: numeric
description: "The total value to be charged for this line, in local currency.
"
description: |
The total value to be charged for this line, in local currency.
- name: line_amount_in_gbp
data_type: numeric
@ -493,24 +492,25 @@ models:
- name: line_amount_wo_taxes_local_curr
data_type: numeric
description: "The total value to be charged for this line, minus taxes, in local
currency.
description: |
In some cases, this will be the same value as the line amount. This
depends on whether there is any tax in the invoice, and whether the
invoice amounts are tax inclusive or tax exclusive. You can find this
out in the details of the invoice this line item belongs to.
"
The total value to be charged for this line, minus taxes, in local
currency.
In some cases, this will be the same value as the line amount. This
depends on whether there is any tax in the invoice, and whether the
invoice amounts are tax inclusive or tax exclusive. You can find this
out in the details of the invoice this line item belongs to.
- name: line_amount_wo_taxes_in_gbp
data_type: numeric
description: "The total value to be charged for this line, minus taxes, in GBP.
description: |
The total value to be charged for this line, minus taxes, in GBP.
In some cases, this will be the same value as the line amount. This
depends on whether there is any tax in the invoice, and whether the
invoice amounts are tax inclusive or tax exclusive. You can find this
out in the details of the invoice this line item belongs to.
"
In some cases, this will be the same value as the line amount. This
depends on whether there is any tax in the invoice, and whether the
invoice amounts are tax inclusive or tax exclusive. You can find this
out in the details of the invoice this line item belongs to.
- name: tax_amount_local_curr
data_type: numeric
@ -534,9 +534,9 @@ out in the details of the invoice this line item belongs to.
- name: reference
data_type: character varying
description: "The Superhog-set reference for the invoices. Only relevant for
records of invoice type (ACCREC).
"
description: |
The Superhog-set reference for the invoices. Only relevant for
records of invoice type (ACCREC).
- name: invoice_number
data_type: character varying
@ -552,41 +552,43 @@ records of invoice type (ACCREC).
- name: was_fully_paid_on_date_utc
data_type: timestamp with time zone
description: "The date on which the invoice was fully paid. If the invoice is still
not fully paid, it returns null.
"
description: |
The date on which the invoice was fully paid. If the invoice is still
not fully paid, it returns null.
- name: invoice_type
data_type: character varying
description: "This field indicates whether the invoice is from Superhog towards a customer
(value is "ACCREC") or from a supplier towards Superhog (value is "ACCPAY").
"
description: |
This field indicates whether the invoice is from Superhog towards a customer
(value is "ACCREC") or from a supplier towards Superhog (value is "ACCPAY").
- name: invoice_currency_iso_4217
data_type: character varying
description: "The currency in which this line item amounts are defined.
description: |
The currency in which this line item amounts are defined.
Line items don't really have a currency definition of its own, this
field is populated for your convenience when working with this data.
The invoice currency is defined at the invoice level, and the values
you see in this field should always be the same as the currency of
the invoice this line item belongs to.
"
Line items don't really have a currency definition of its own, this
field is populated for your convenience when working with this data.
The invoice currency is defined at the invoice level, and the values
you see in this field should always be the same as the currency of
the invoice this line item belongs to.
- name: exchange_rate_to_gbp
data_type: numeric
description: "The implied exchange rate between the invoice currency and GBP.
description: |
The implied exchange rate between the invoice currency and GBP.
This is the XXX to GBP rate. So the number represented in this field is the units of currency GBP
that 1 unit of XXX buys you.
This is the XXX to GBP rate. So the number represented in this field
is the units of currency GBP that 1 unit of XXX buys you.
For example, if the invoice is 135 ZAR, and this rate is 0.0167, the invoice value in GBP is 2.25
(135ZAR * 0.0167GBP/ZAR = 2.25GBP).
"
For example, if the invoice is 135 ZAR, and this rate is 0.0167, the
invoice value in GBP is 2.25 (135ZAR * 0.0167GBP/ZAR = 2.25GBP).
- name: total_amount_local_curr
data_type: numeric
description: "The total amount to be paid, in the currency the invoice is denominated in."
description: |
The total amount to be paid, in the currency the invoice is
denominated in.
- name: total_amount_in_gbp
data_type: numeric
@ -594,15 +596,19 @@ For example, if the invoice is 135 ZAR, and this rate is 0.0167, the invoice val
- name: total_amount_wo_tax_local_curr
data_type: numeric
description: "The total amount to be paid minus taxes, in the currency the invoice is denominated in."
description: |
The total amount to be paid minus taxes, in the currency the invoice
is denominated in.
- name: total_amount_wo_tax_in_gbp
data_type: numeric
description: "The total amount to be paid minus taxes, converted to GBP."
description: |
The total amount to be paid minus taxes, converted to GBP.
- name: total_tax_local_curr
data_type: numeric
description: "The total tax, in the currency the invoice is denominated in."
description: |
The total tax, in the currency the invoice is denominated in.
- name: total_tax_in_gbp
data_type: numeric
@ -610,15 +616,20 @@ For example, if the invoice is 135 ZAR, and this rate is 0.0167, the invoice val
- name: total_due_local_curr
data_type: numeric
description: "The total amount outstanding right now, in the currency the invoice is denominated in."
description: |
The total amount outstanding right now, in the currency the invoice
is denominated in.
- name: total_due_in_gbp
data_type: numeric
description: "The total amount outstanding right now, converted to GBP."
description: |
The total amount outstanding right now, converted to GBP.
- name: total_paid_local_curr
data_type: numeric
description: "The total amount that has already been paid, in the currency the invoice is denominated in."
description: |
The total amount that has already been paid, in the currency the
invoice is denominated in.
- name: total_paid_in_gbp
data_type: numeric
@ -626,12 +637,13 @@ For example, if the invoice is 135 ZAR, and this rate is 0.0167, the invoice val
- name: invoice_status
data_type: character varying
description: "The status of the invoice.
description: |
Can be one of: PAID, VOIDED, DRAFT, DELETED, AUTHORISED, SUBMITTED.
The status of the invoice.
You can read more here: https://developer.xero.com/documentation/api/accounting/types#invoices
"
Can be one of PAID, VOIDED, DRAFT, DELETED, AUTHORISED, SUBMITTED.
You can read more here https://developer.xero.com/documentation/api/accounting/types#invoices
- name: has_errors
data_type: boolean
@ -659,7 +671,9 @@ You can read more here: https://developer.xero.com/documentation/api/accounting/
- name: total_credited_local_curr
data_type: numeric
description: "Total amount credited by related credit notes, over-payments and pre-payments."
description: |
Total amount credited by related credit notes,
over-payments and pre-payments.
- name: has_attachments
data_type: boolean
@ -667,10 +681,10 @@ You can read more here: https://developer.xero.com/documentation/api/accounting/
- name: line_amount_tax_inclusiveness
data_type: character varying
description: "Indicates whether the amounts included in line items are tax
inclusive (Inclusive), tax exclusive (Exclusive) or simply,
there are no taxes on the invoice (NoTax).
"
description: |
Indicates whether the amounts included in line items are tax
inclusive (Inclusive), tax exclusive (Exclusive) or simply,
there are no taxes on the invoice (NoTax).
- name: payment_planned_date_utc
data_type: timestamp with time zone
@ -686,16 +700,17 @@ there are no taxes on the invoice (NoTax).
- name: account_number
data_type: character varying
description: "A Superhog set identifier. For customers, this is Hubspot's Deal Id."
description: |
A Superhog set identifier. For customers, this is Hubspot's Deal Id.
- name: id_deal
data_type: text
description: "For those account numbers that look like a Deal Id, we extract them
into this field. Other contacs will have a blank.
description: |
For those account numbers that look like a Deal Id, we extract them
into this field. Other contacs will have a blank.
You can use this to find specific deal ids or even as a proxy bool to
keep or remove deal id customers.
"
You can use this to find specific deal ids or even as a proxy bool to
keep or remove deal id customers.
- name: contact_name
data_type: character varying
@ -787,10 +802,10 @@ keep or remove deal id customers.
- name: default_currency_iso_4217
data_type: character varying
description: "The default currency used to interact with this contact.
description: |
The default currency used to interact with this contact.
For customers, this is the currency we will usually use to invoice.
"
For customers, this is the currency we will usually use to invoice.
- name: validation_errors
data_type: jsonb
@ -835,4 +850,3 @@ For customers, this is the currency we will usually use to invoice.
- name: purchases_tracking_categories
data_type: jsonb
description: ""