PSA/shared/billingClients/taxSettings.ts
Hermes 284313f908
Some checks are pending
Bidi Control Character Guard / bidi-control-guard (push) Waiting to run
Circular Dependency Check / Check for new circular dependencies (push) Waiting to run
Citus Migration Smoke / Combined migrations on single-node Citus (push) Waiting to run
E2E Fresh Install Tests / fresh-install-e2e (push) Waiting to run
ext-v2 guardrails / Run ext-v2 guard and ESLint (push) Waiting to run
Integration Tests / Check for relevant changes (push) Waiting to run
Integration Tests / ${{ (github.event_name == 'schedule' || github.event.inputs.suite == 'full') && 'Full integration suite' || 'Tier-1 integration subset' }} (push) Blocked by required conditions
Mobile checks / Mobile lint + typecheck (push) Waiting to run
Mobile checks / Mobile unit tests (push) Waiting to run
Mobile checks / Mobile dependency audit (report) (push) Waiting to run
Mobile checks / Mobile reproducibility checks (push) Waiting to run
Secrets guard (env backups) / Ensure no tracked env backup files (push) Waiting to run
Temporal Readiness / fast-readiness (push) Waiting to run
Temporal Readiness / docker-parity (push) Waiting to run
TypeScript Type Check / Nx affected typecheck (push) Waiting to run
Unit Tests / Skipped-test budget (push) Waiting to run
Unit Tests / Nx affected unit tests (push) Waiting to run
Unit Tests / Server unit coverage (informational) (push) Waiting to run
Validate Tenant Management Schema / Check for relevant changes (push) Waiting to run
Validate Tenant Management Schema / Validate Tenant Management Schema (push) Blocked by required conditions
EE Workflows Build Guard / ee-workflows-build-guard (push) Waiting to run
Initial import of AlgaPSA codebase from PSA server
Excluded: .git, node_modules, secrets/, compose.env, assemblyscript tgz

Source: /opt/alga-psa on psa.joliet.tech
2026-06-22 16:12:17 -05:00

164 lines
4.7 KiB
TypeScript

import type { Knex } from 'knex';
import { v4 as uuid4 } from 'uuid';
import type { IClientTaxSettings, ITaxRateDetails as ITaxRate, ITaxComponent, TaxSource } from '@alga-psa/types';
export async function getClientTaxSettings(
knexOrTrx: Knex | Knex.Transaction,
tenant: string,
clientId: string
): Promise<IClientTaxSettings | null> {
const row = await knexOrTrx<IClientTaxSettings>('client_tax_settings')
.where({ client_id: clientId, tenant })
.first();
return row ?? null;
}
export async function updateClientTaxSettings(
knexOrTrx: Knex | Knex.Transaction,
tenant: string,
clientId: string,
taxSettings: Omit<IClientTaxSettings, 'tenant'>
): Promise<IClientTaxSettings | null> {
await knexOrTrx<IClientTaxSettings>('client_tax_settings')
.where({ client_id: clientId, tenant })
.update({
is_reverse_charge_applicable: taxSettings.is_reverse_charge_applicable,
tax_source_override: taxSettings.tax_source_override ?? null
});
const updated = await knexOrTrx<IClientTaxSettings>('client_tax_settings')
.where({ client_id: clientId, tenant })
.first();
return updated ?? null;
}
export async function createDefaultTaxSettings(
knexOrTrx: Knex | Knex.Transaction,
tenant: string,
clientId: string
): Promise<IClientTaxSettings> {
// Get the first active tax rate to use as the default
const defaultTaxRate = await knexOrTrx<ITaxRate>('tax_rates')
.where('tenant', tenant)
.andWhere('is_active', true)
.orderBy('created_at', 'asc')
.first();
if (!defaultTaxRate) {
throw new Error('No active tax rates found in the system to assign as default.');
}
const [taxSettings] = await knexOrTrx<IClientTaxSettings>('client_tax_settings')
.insert({
client_id: clientId,
is_reverse_charge_applicable: false,
tenant
})
.returning('*');
await knexOrTrx('client_tax_rates').insert({
client_id: clientId,
tax_rate_id: defaultTaxRate.tax_rate_id,
is_default: true,
location_id: null,
tenant
});
const tax_component_id = uuid4();
await knexOrTrx<ITaxComponent>('tax_components').insert({
tax_component_id,
tax_rate_id: defaultTaxRate.tax_rate_id,
name: 'Default Tax',
rate: Math.ceil((defaultTaxRate as any).tax_percentage),
sequence: 1,
is_compound: false,
tenant
});
return taxSettings as IClientTaxSettings;
}
export async function getClientTaxExemptStatus(
knexOrTrx: Knex | Knex.Transaction,
tenant: string,
clientId: string
): Promise<{ is_tax_exempt: boolean; tax_exemption_certificate?: string } | null> {
const row = await knexOrTrx('clients')
.where({ client_id: clientId, tenant })
.first()
.select('is_tax_exempt', 'tax_exemption_certificate');
if (!row) return null;
return {
is_tax_exempt: Boolean((row as any).is_tax_exempt),
tax_exemption_certificate: (row as any).tax_exemption_certificate ?? ''
};
}
export async function updateClientTaxExemptStatus(
knexOrTrx: Knex | Knex.Transaction,
tenant: string,
clientId: string,
isTaxExempt: boolean,
taxExemptionCertificate?: string
): Promise<{ is_tax_exempt: boolean; tax_exemption_certificate?: string }> {
const updateData: { is_tax_exempt: boolean; tax_exemption_certificate?: string } = {
is_tax_exempt: isTaxExempt
};
if (taxExemptionCertificate !== undefined) {
updateData.tax_exemption_certificate = taxExemptionCertificate;
} else if (!isTaxExempt) {
updateData.tax_exemption_certificate = '';
}
await knexOrTrx('clients').where({ client_id: clientId, tenant }).update(updateData);
return updateData;
}
export type ClientTaxSourceInfo = {
taxSource: TaxSource;
isOverride: boolean;
};
export async function getEffectiveTaxSourceForClient(
knexOrTrx: Knex | Knex.Transaction,
tenant: string,
clientId: string
): Promise<ClientTaxSourceInfo> {
const clientSettings = await knexOrTrx('client_tax_settings')
.where({ client_id: clientId, tenant })
.select('tax_source_override')
.first();
if (clientSettings?.tax_source_override) {
return {
taxSource: clientSettings.tax_source_override as TaxSource,
isOverride: true
};
}
const tenantSettings = await knexOrTrx('tenant_settings')
.where({ tenant })
.select('default_tax_source', 'allow_external_tax_override')
.first();
return {
taxSource: (tenantSettings?.default_tax_source as TaxSource) || 'internal',
isOverride: false
};
}
export async function canClientOverrideTaxSource(
knexOrTrx: Knex | Knex.Transaction,
tenant: string
): Promise<boolean> {
const tenantSettings = await knexOrTrx('tenant_settings')
.where({ tenant })
.select('allow_external_tax_override')
.first();
return Boolean(tenantSettings?.allow_external_tax_override);
}