feat: add default include tax field to companies

Author: stefanvanherwijnen

packages/api/src/kysely/migrations/10_add_default_include_tax_to_companies_table.ts

@@ -0,0 +1,15 @@
+import type { Kysely } from 'kysely'
+
+export async function up(db: Kysely<unknown>): Promise<void> {
+  await db.schema
+    .alterTable('companies')
+    .addColumn('default_include_tax', 'boolean', (col) => col.defaultTo(true))
+    .execute()
+}
+
+export async function down(db: Kysely<unknown>): Promise<void> {
+  await db.schema
+    .alterTable('companies')
+    .dropColumn('default_include_tax')
+    .execute()
+}

packages/api/src/kysely/types.ts

@@ -53,6 +53,7 @@ export interface Companies {
   defaultNumberPrefixTemplate: string | null
   defaultLocale: string | null
   defaultCurrency: 'EUR' | 'USD' | null
+  defaultIncludeTax: Generated<boolean>
   createdAt: Generated<string>
 }
 

packages/api/src/repositories/company.ts

@@ -26,7 +26,8 @@ const defaultSelect = [
   'website',
   'defaultNumberPrefixTemplate',
   'defaultLocale',
-  'defaultCurrency'
+  'defaultCurrency',
+  'defaultIncludeTax'
 ] as (keyof Company)[]
 
 function find({

packages/api/src/trpc/admin/companies.ts

@@ -40,7 +40,8 @@ export const adminCompanyRoutes = ({
       prefix,
       defaultNumberPrefixTemplate,
       defaultLocale,
-      defaultCurrency
+      defaultCurrency,
+      defaultIncludeTax
     } = input
 
     let logoSvg = input.logoSvg
@@ -71,7 +72,8 @@ export const adminCompanyRoutes = ({
       logoSvg,
       defaultNumberPrefixTemplate,
       defaultLocale,
-      defaultCurrency
+      defaultCurrency,
+      defaultIncludeTax
     })
     if (result) return result
 
@@ -120,7 +122,8 @@ export const adminCompanyRoutes = ({
         prefix,
         defaultNumberPrefixTemplate,
         defaultLocale,
-        defaultCurrency
+        defaultCurrency,
+        defaultIncludeTax
       } = input
 
       let logoSvg = input.logoSvg
@@ -155,7 +158,8 @@ export const adminCompanyRoutes = ({
           logoSvg,
           defaultNumberPrefixTemplate,
           defaultLocale,
-          defaultCurrency
+          defaultCurrency,
+          defaultIncludeTax
         }
       )
       if (result) return result

packages/api/src/zod/company.ts

@@ -38,7 +38,8 @@ export const companyValidation = {
   defaultCurrency: z
     .union([z.literal('EUR'), z.literal('USD')])
     .nullable()
-    .optional()
+    .optional(),
+  defaultIncludeTax: z.boolean().optional()
 }
 
 export const company = z.object(companyValidation)

packages/app/src/components/company/CompanyForm.vue

@@ -190,6 +190,14 @@
         lazy-rules
         name="defaultCurrency"
       />
+      <boolean-select
+        v-model="modelValue.defaultIncludeTax"
+        :label="lang.company.fields.defaultIncludeTax"
+        class="md:col-span-3 col-span-12"
+        bottom-slots
+        lazy-rules
+        name="defaultIncludeTax"
+      />
     </div>
   </q-form>
 </template>
@@ -204,7 +212,8 @@ import SvgAvatar from '../SvgAvatar.vue'
 import NumberPrefixSelect from '../numberPrefix/NumberPrefixSelect.vue'
 import {
   LocaleSelect,
-  CurrencySelect
+  CurrencySelect,
+  BooleanSelect
 } from '@simsustech/quasar-components/form'
 import { Company, NumberPrefix } from '@slimfact/api/zod'
 export interface Props {
@@ -255,7 +264,8 @@ const initialValue: Company = {
   website: null,
   defaultNumberPrefixTemplate: '',
   defaultLocale: 'en-US',
-  defaultCurrency: 'EUR'
+  defaultCurrency: 'EUR',
+  defaultIncludeTax: true
 }
 
 const modelValue = ref<Company>(initialValue)

packages/app/src/components/invoice/InvoiceForm.vue

@@ -333,7 +333,7 @@ const filterClients: InstanceType<
 const addLine = () => {
   modelValue.value.lines.push({
     listPrice: 0,
-    listPriceIncludesTax: true,
+    listPriceIncludesTax: includeTax.value,
     taxRate: 21,
     description: '',
     quantity: 1000,
@@ -408,6 +408,8 @@ const setValue = (newValue: RawNewInvoice) => {
   }
 }
 
+const includeTax = ref(true)
+
 watch(
   () => modelValue.value.companyId,
   (newVal) => {
@@ -421,12 +423,19 @@ watch(
     const defaultLocale = filteredCompanies.value.find(
       (company) => company.id === newVal
     )?.defaultLocale
-    if (defaultLocale) modelValue.value.locale = defaultLocale
+    if (defaultLocale !== void 0 && defaultLocale !== null)
+      modelValue.value.locale = defaultLocale
 
     const defaultCurrency = filteredCompanies.value.find(
       (company) => company.id === newVal
     )?.defaultCurrency
-    if (defaultCurrency) modelValue.value.currency = defaultCurrency
+    if (defaultCurrency !== void 0 && defaultCurrency !== null)
+      modelValue.value.currency = defaultCurrency
+
+    const defaultIncludeTax = filteredCompanies.value.find(
+      (company) => company.id === newVal
+    )?.defaultIncludeTax
+    if (defaultIncludeTax !== void 0) includeTax.value = defaultIncludeTax
   }
 )
 

packages/app/src/lang/en-US.ts

@@ -70,7 +70,8 @@ const lang: Language = {
       bic: 'BIC',
       defaultNumberPrefixTemplate: 'Default number prefix',
       defaultLocale: 'Default locale',
-      defaultCurrency: 'Default currency'
+      defaultCurrency: 'Default currency',
+      defaultIncludeTax: 'Default incl. VAT'
     },
     validations: {
       fieldRequired: 'Field is required'

packages/app/src/lang/index.ts

@@ -70,6 +70,7 @@ export interface Language {
       defaultNumberPrefixTemplate: string
       defaultLocale: string
       defaultCurrency: string
+      defaultIncludeTax: string
     }
     validations: {
       fieldRequired: string

packages/app/src/lang/nl.ts

@@ -70,7 +70,8 @@ const lang: Language = {
       bic: 'BIC',
       defaultNumberPrefixTemplate: 'Standaard nummer voorvoegsel',
       defaultLocale: 'Standaard regio',
-      defaultCurrency: 'Standaard valuta'
+      defaultCurrency: 'Standaard valuta',
+      defaultIncludeTax: 'Standaard incl. btw'
     },
     validations: {
       fieldRequired: 'Veld is vereist'