more docs

models/reporting/xero/schema.yaml

@@ -3,8 +3,11 @@ version: 2
 models:
   - name: xero__invoices
     description: |
-      Invoice data from Xero. Each record corresponds to one specific invoiced.
+      Invoices that we have raised within our accounting books.
 
+      This includes both our invoices towards customers and invoices provided by our suppliers.
+
+      You can read more here: https://developer.xero.com/documentation/api/accounting/invoices
 
     columns:
       - name: id_invoice
@@ -24,7 +27,7 @@ models:
         data_type: character varying
         description: |
           The Superhog-set reference for the invoices. Only relevant for 
-          records of invoice type (ACCREC). 
+          records of invoice type (ACCREC).
 
       - name: invoice_number
         data_type: character varying
@@ -56,9 +59,9 @@ models:
 
       - name: exchange_rate_to_gbp
         data_type: numeric
-        description: | 
+        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. 
 
@@ -140,8 +143,8 @@ models:
 
       - name: total_credited_local_curr
         data_type: numeric
-        description: 
-          Total amount credited by related credit notes, over-payments and 
+        description:
+          Total amount credited by related credit notes, over-payments and
           pre-payments.
 
       - name: has_attachments
@@ -173,4 +176,95 @@ models:
 
       - name: dwh_extracted_at_utc
         data_type: timestamp with time zone
-        description: ""
+        description: ""
+
+  - name: xero__invoice_line_items
+    description: |
+      Invoice line items. Every record corresponds to a Line Item in Xero.
+
+      A Line Item is a combination of a specific service or item being sold,
+      together with its quantity, price, total amount and taxes.
+
+      You can read more here: https://developer.xero.com/documentation/api/accounting/invoices
+
+    columns:
+      - name: id_invoice
+        data_type: character varying
+        description: Xero's unique identifier for the invoice.
+
+      - name: id_line_item
+        data_type: text
+        description: Xero's unique identifier for the line item.
+
+      - name: id_item
+        data_type: text
+        description: Xero's unique identifier for the item of this line.
+
+      - name: item_code
+        data_type: text
+        description: A text based code that describes the Item.
+
+      - name: quantity
+        data_type: numeric
+        description: How much of the item is sold in its invoice.
+
+      - name: unit_amount
+        data_type: numeric
+        description: The price of each unit of the item.
+
+      - name: line_amount_local_curr
+        data_type: numeric
+        description: |
+          The total value to be charged for this line, in local currency.
+
+      - name: line_amount_in_gbp
+        data_type: numeric
+        description: The total value to be charged for this line, in GBP.
+
+      - 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.
+
+          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.
+
+          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
+        description: The total value of taxes for this line, in local currency.
+
+      - name: tax_amount_in_gbp
+        data_type: numeric
+        description: The total value of taxes for this line, in GBP.
+
+      - name: tax_type
+        data_type: text
+        description: ""
+
+      - name: invoice_currency_iso_4217
+        data_type: character varying
+        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.
+
+      - name: line_description
+        data_type: text
+        description: A text description of the line item.