feat: Add tax numbers to the organization details (#269)

packages/server/src/api/controllers/Organization.ts

@@ -31,14 +31,14 @@ export default class OrganizationController extends BaseController {
 
     router.post(
       '/build',
-      this.organizationValidationSchema,
+      this.buildOrganizationValidationSchema,
       this.validationResult,
       asyncMiddleware(this.build.bind(this)),
       this.handleServiceErrors.bind(this)
     );
     router.put(
       '/',
-      this.organizationValidationSchema,
+      this.updateOrganizationValidationSchema,
       this.validationResult,
       this.asyncMiddleware(this.updateOrganization.bind(this)),
       this.handleServiceErrors.bind(this)
@@ -55,7 +55,7 @@ export default class OrganizationController extends BaseController {
    * Organization setup schema.
    * @return {ValidationChain[]}
    */
-  private get organizationValidationSchema(): ValidationChain[] {
+  private get commonOrganizationValidationSchema(): ValidationChain[] {
     return [
       check('name').exists().trim(),
       check('industry').optional({ nullable: true }).isString().trim().escape(),
@@ -68,6 +68,29 @@ export default class OrganizationController extends BaseController {
     ];
   }
 
+  /**
+   * Build organization validation schema.
+   * @returns {ValidationChain[]}
+   */
+  private get buildOrganizationValidationSchema(): ValidationChain[] {
+    return [...this.commonOrganizationValidationSchema];
+  }
+
+  /**
+   * Update organization validation schema.
+   * @returns {ValidationChain[]}
+   */
+  private get updateOrganizationValidationSchema(): ValidationChain[] {
+    return [
+      ...this.commonOrganizationValidationSchema,
+      check('tax_number')
+        .optional({ nullable: true })
+        .isString()
+        .trim()
+        .escape(),
+    ];
+  }
+
   /**
    * Builds tenant database and migrate database schema.
    * @param {Request} req - Express request.

packages/server/src/interfaces/Setup.ts

@@ -25,6 +25,7 @@ export interface IOrganizationUpdateDTO {
   timezone: string;
   fiscalYear: string;
   industry: string;
+  taxNumber: string;
 }
 
 export interface IOrganizationBuildEventPayload {

packages/server/src/system/migrations/20231012112401_add_tax_number_column_to_tenants_metadata_table.js

@@ -0,0 +1,11 @@
+exports.up = function (knex) {
+  return knex.schema.table('tenants_metadata', (table) => {
+    table.string('tax_number')
+  });
+};
+
+exports.down = function (knex) {
+  return knex.schema.table('tenants_metadata', (table) => {
+    table.dropColumn('tax_number');
+  });
+};