@bisondesk/core-sdk 1.0.676 → 1.0.678

package/lib/utils/tenants.js

@@ -1,4 +1,5 @@
 import { XError } from '@bisondesk/commons-sdk/errors';
+import { isEUCountry } from '@bisondesk/commons-sdk/locations';
 import { first } from 'lodash-es';
 export const getBranch = (tenant, branchId) => {
     const branch = tenant.branches.find((branch) => branch.id === branchId);
@@ -8,6 +9,10 @@ export const getBranch = (tenant, branchId) => {
     return branch;
 };
 export const getDefaultBranch = (tenant) => first(tenant.branches);
+export const getBranchAskingVies = (tenant, branchId) => {
+    const europeanBranches = tenant.branches.filter((branch) => isEUCountry(branch.country));
+    return europeanBranches.find((branch) => branch.id === branchId) ?? europeanBranches.at(0);
+};
 export const isDropshippingBranch = (branch) => branch.dropshipping === true;
 export const getBranchStandardVatRate = (tenant, branchId) => {
     const branch = getBranch(tenant, branchId);

package/lib/utils/tenants.js.map

@@ -1 +1 @@
-{"version":3,"file":"tenants.js","sourceRoot":"/","sources":["utils/tenants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAGlC,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,MAAc,EAAE,QAAgB,EAAU,EAAE;IACpE,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAc,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC;IAChF,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;QACnB,MAAM,IAAI,MAAM,CAAC,0BAA0B,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClF,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAAU,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAE,CAAC;AAIpF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,MAAc,EAAW,EAAE,CAAC,MAAM,CAAC,YAAY,KAAK,IAAI,CAAC;AAE9F,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,MAAc,EAAE,QAAgB,EAAU,EAAE;IACnF,MAAM,MAAM,GAAW,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACnD,OAAO,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;AAClC,CAAC,CAAC;AAOF,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAS,EAAE,CAAS,EAAW,EAAE,CAC1E,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO;IACvB,CAAC,CAAC,QAAQ,KAAK,CAAC,CAAC,QAAQ;IACzB,CAAC,CAAC,QAAQ,CAAC,QAAQ,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ;IAC3C,CAAC,CAAC,CAAC,aAAa,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa,IAAI,KAAK,CAAC,CAAC","sourcesContent":["import { XError } from '@bisondesk/commons-sdk/errors';\nimport { first } from 'lodash-es';\nimport { Branch, Tenant } from '../types/tenants.js';\n\nexport const getBranch = (tenant: Tenant, branchId: string): Branch => {\n  const branch = tenant.branches.find((branch: Branch) => branch.id === branchId);\n  if (branch == null) {\n    throw new XError('tenants.branch-not-found', { tenantId: tenant.id, branchId });\n  }\n\n  return branch;\n};\n\nexport const getDefaultBranch = (tenant: Tenant): Branch => first(tenant.branches)!;\n\n/** The source invoices the end customer directly; this branch collects payment and earns\n * commission (see {@link Branch.dropshipping}). */\nexport const isDropshippingBranch = (branch: Branch): boolean => branch.dropshipping === true;\n\nexport const getBranchStandardVatRate = (tenant: Tenant, branchId: string): string => {\n  const branch: Branch = getBranch(tenant, branchId);\n  return branch.vatRates.standard;\n};\n\n/**\n * Whether a quote computed for one branch is still right for the other. A quote's VAT regime,\n * currency, calculator strategy and conditions all come from these four fields, so when they\n * agree the quote can move with its deal; otherwise the deal needs a new one.\n */\nexport const areBranchesQuoteCompatible = (a: Branch, b: Branch): boolean =>\n  a.country === b.country &&\n  a.currency === b.currency &&\n  a.vatRates.standard === b.vatRates.standard &&\n  (a.externalQuote ?? false) === (b.externalQuote ?? false);\n"]}
+{"version":3,"file":"tenants.js","sourceRoot":"/","sources":["utils/tenants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC/D,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAGlC,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,MAAc,EAAE,QAAgB,EAAU,EAAE;IACpE,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAc,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC;IAChF,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;QACnB,MAAM,IAAI,MAAM,CAAC,0BAA0B,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClF,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAAU,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAE,CAAC;AAOpF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,MAAc,EAAE,QAAiB,EAAsB,EAAE;IAC3F,MAAM,gBAAgB,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IACzF,OAAO,gBAAgB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,QAAQ,CAAC,IAAI,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAC7F,CAAC,CAAC;AAIF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,MAAc,EAAW,EAAE,CAAC,MAAM,CAAC,YAAY,KAAK,IAAI,CAAC;AAE9F,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,MAAc,EAAE,QAAgB,EAAU,EAAE;IACnF,MAAM,MAAM,GAAW,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACnD,OAAO,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;AAClC,CAAC,CAAC;AAOF,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAS,EAAE,CAAS,EAAW,EAAE,CAC1E,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,OAAO;IACvB,CAAC,CAAC,QAAQ,KAAK,CAAC,CAAC,QAAQ;IACzB,CAAC,CAAC,QAAQ,CAAC,QAAQ,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ;IAC3C,CAAC,CAAC,CAAC,aAAa,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,aAAa,IAAI,KAAK,CAAC,CAAC","sourcesContent":["import { XError } from '@bisondesk/commons-sdk/errors';\nimport { isEUCountry } from '@bisondesk/commons-sdk/locations';\nimport { first } from 'lodash-es';\nimport { Branch, Tenant } from '../types/tenants.js';\n\nexport const getBranch = (tenant: Tenant, branchId: string): Branch => {\n  const branch = tenant.branches.find((branch: Branch) => branch.id === branchId);\n  if (branch == null) {\n    throw new XError('tenants.branch-not-found', { tenantId: tenant.id, branchId });\n  }\n\n  return branch;\n};\n\nexport const getDefaultBranch = (tenant: Tenant): Branch => first(tenant.branches)!;\n\n/**\n * The branch whose VAT number VIES records as the requester of a VAT check, which earns a\n * consultation number: the branch the check is made for when it is European, else the tenant's\n * first European branch. A tenant without a European branch asks VIES anonymously.\n */\nexport const getBranchAskingVies = (tenant: Tenant, branchId?: string): Branch | undefined => {\n  const europeanBranches = tenant.branches.filter((branch) => isEUCountry(branch.country));\n  return europeanBranches.find((branch) => branch.id === branchId) ?? europeanBranches.at(0);\n};\n\n/** The source invoices the end customer directly; this branch collects payment and earns\n * commission (see {@link Branch.dropshipping}). */\nexport const isDropshippingBranch = (branch: Branch): boolean => branch.dropshipping === true;\n\nexport const getBranchStandardVatRate = (tenant: Tenant, branchId: string): string => {\n  const branch: Branch = getBranch(tenant, branchId);\n  return branch.vatRates.standard;\n};\n\n/**\n * Whether a quote computed for one branch is still right for the other. A quote's VAT regime,\n * currency, calculator strategy and conditions all come from these four fields, so when they\n * agree the quote can move with its deal; otherwise the deal needs a new one.\n */\nexport const areBranchesQuoteCompatible = (a: Branch, b: Branch): boolean =>\n  a.country === b.country &&\n  a.currency === b.currency &&\n  a.vatRates.standard === b.vatRates.standard &&\n  (a.externalQuote ?? false) === (b.externalQuote ?? false);\n"]}

package/lib/utils/tenants.test.js

@@ -1,4 +1,4 @@
-import { areBranchesQuoteCompatible } from './tenants.js';
+import { areBranchesQuoteCompatible, getBranchAskingVies } from './tenants.js';
 const createBranch = (override) => ({
     id: 'TTC',
     name: 'TTC Belgium',
@@ -36,4 +36,21 @@ describe('areBranchesQuoteCompatible', () => {
         expect(areBranchesQuoteCompatible(implicit, explicit)).toBe(true);
     });
 });
+describe('getBranchAskingVies', () => {
+    const bolivia = createBranch({ id: 'BO', country: 'bo', vatNumber: '387032026' });
+    const belgium = createBranch({ id: 'BE', country: 'be', vatNumber: 'BE0405567886' });
+    const france = createBranch({ id: 'FR', country: 'fr', vatNumber: 'FR10821739638' });
+    const tenantOf = (branches) => ({ branches });
+    test.each([
+        ['the European branch the check is made for', 'FR', 'FR'],
+        ['the first European branch when no branch is given', undefined, 'BE'],
+        ['the first European branch when the given branch is outside the EU', 'BO', 'BE'],
+        ['the first European branch when the given branch is unknown', 'GONE', 'BE'],
+    ])('picks %s', (_label, branchId, expected) => {
+        expect(getBranchAskingVies(tenantOf([bolivia, belgium, france]), branchId)?.id).toBe(expected);
+    });
+    test('asks anonymously for a tenant without a European branch', () => {
+        expect(getBranchAskingVies(tenantOf([bolivia]), 'BO')).toBeUndefined();
+    });
+});
 //# sourceMappingURL=tenants.test.js.map

package/lib/utils/tenants.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"tenants.test.js","sourceRoot":"/","sources":["utils/tenants.test.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAE1D,MAAM,YAAY,GAAG,CAAC,QAA0B,EAAU,EAAE,CAAC,CAAC;IAC5D,EAAE,EAAE,KAAK;IACT,IAAI,EAAE,aAAa;IACnB,OAAO,EAAE,IAAI;IACb,QAAQ,EAAE,IAAI;IACd,QAAQ,EAAE,KAAK;IACf,iBAAiB,EAAE,IAAI;IACvB,iBAAiB,EAAE,IAAI;IACvB,SAAS,EAAE,cAAc;IACzB,QAAQ,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;IAC5B,QAAQ,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;IAC3B,GAAG,QAAQ;CACZ,CAAC,CAAC;AAEH,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IAC1C,EAAE,CAAC,+EAA+E,EAAE,GAAG,EAAE;QACvF,MAAM,CAAC,GAAG,YAAY,EAAE,CAAC;QACzB,MAAM,CAAC,GAAG,YAAY,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;QAErF,MAAM,CAAC,0BAA0B,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;QAE9B,MAAM,CAAC,0BAA0B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC;QACN,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QAC9B,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;QACjC,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC;QAC9C,CAAC,qBAAqB,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;KACjD,CAAC,CAAC,oCAAoC,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;QAC5D,MAAM,CAAC,0BAA0B,CAAC,YAAY,EAAE,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qEAAqE,EAAE,GAAG,EAAE;QAC7E,MAAM,QAAQ,GAAG,YAAY,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,YAAY,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAC;QAExD,MAAM,CAAC,0BAA0B,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { Branch } from '../types/tenants.js';\nimport { areBranchesQuoteCompatible } from './tenants.js';\n\nconst createBranch = (override?: Partial<Branch>): Branch => ({\n  id: 'TTC',\n  name: 'TTC Belgium',\n  country: 'be',\n  language: 'nl',\n  currency: 'EUR',\n  adminNumberPrefix: 'AT',\n  stockNumberPrefix: 'TC',\n  vatNumber: 'BE0123456789',\n  vatRates: { standard: '21' },\n  location: { country: 'be' },\n  ...override,\n});\n\ndescribe('areBranchesQuoteCompatible', () => {\n  it('accepts two branches that agree on country, currency, vat rate and quote mode', () => {\n    const a = createBranch();\n    const b = createBranch({ id: 'TTC2', name: 'TTC Antwerp', stockNumberPrefix: 'TA' });\n\n    expect(areBranchesQuoteCompatible(a, b)).toBe(true);\n  });\n\n  it('is true for a branch compared with itself', () => {\n    const branch = createBranch();\n\n    expect(areBranchesQuoteCompatible(branch, branch)).toBe(true);\n  });\n\n  it.each([\n    ['country', { country: 'fr' }],\n    ['currency', { currency: 'USD' }],\n    ['vat rate', { vatRates: { standard: '20' } }],\n    ['external quote mode', { externalQuote: true }],\n  ])('rejects branches that differ in %s', (_label, override) => {\n    expect(areBranchesQuoteCompatible(createBranch(), createBranch(override))).toBe(false);\n  });\n\n  it('treats a missing externalQuote as false rather than as a difference', () => {\n    const implicit = createBranch();\n    const explicit = createBranch({ externalQuote: false });\n\n    expect(areBranchesQuoteCompatible(implicit, explicit)).toBe(true);\n  });\n});\n"]}
+{"version":3,"file":"tenants.test.js","sourceRoot":"/","sources":["utils/tenants.test.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,0BAA0B,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAE/E,MAAM,YAAY,GAAG,CAAC,QAA0B,EAAU,EAAE,CAAC,CAAC;IAC5D,EAAE,EAAE,KAAK;IACT,IAAI,EAAE,aAAa;IACnB,OAAO,EAAE,IAAI;IACb,QAAQ,EAAE,IAAI;IACd,QAAQ,EAAE,KAAK;IACf,iBAAiB,EAAE,IAAI;IACvB,iBAAiB,EAAE,IAAI;IACvB,SAAS,EAAE,cAAc;IACzB,QAAQ,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;IAC5B,QAAQ,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;IAC3B,GAAG,QAAQ;CACZ,CAAC,CAAC;AAEH,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IAC1C,EAAE,CAAC,+EAA+E,EAAE,GAAG,EAAE;QACvF,MAAM,CAAC,GAAG,YAAY,EAAE,CAAC;QACzB,MAAM,CAAC,GAAG,YAAY,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;QAErF,MAAM,CAAC,0BAA0B,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;QAE9B,MAAM,CAAC,0BAA0B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC;QACN,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QAC9B,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;QACjC,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC;QAC9C,CAAC,qBAAqB,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;KACjD,CAAC,CAAC,oCAAoC,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;QAC5D,MAAM,CAAC,0BAA0B,CAAC,YAAY,EAAE,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qEAAqE,EAAE,GAAG,EAAE;QAC7E,MAAM,QAAQ,GAAG,YAAY,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,YAAY,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAC;QAExD,MAAM,CAAC,0BAA0B,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,MAAM,OAAO,GAAG,YAAY,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,CAAC;IAClF,MAAM,OAAO,GAAG,YAAY,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,cAAc,EAAE,CAAC,CAAC;IACrF,MAAM,MAAM,GAAG,YAAY,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,eAAe,EAAE,CAAC,CAAC;IACrF,MAAM,QAAQ,GAAG,CAAC,QAAkB,EAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAW,CAAC;IAElE,IAAI,CAAC,IAAI,CAAC;QACR,CAAC,2CAA2C,EAAE,IAAI,EAAE,IAAI,CAAC;QACzD,CAAC,mDAAmD,EAAE,SAAS,EAAE,IAAI,CAAC;QACtE,CAAC,mEAAmE,EAAE,IAAI,EAAE,IAAI,CAAC;QACjF,CAAC,4DAA4D,EAAE,MAAM,EAAE,IAAI,CAAC;KAC7E,CAAC,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE;QAC5C,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjG,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,yDAAyD,EAAE,GAAG,EAAE;QACnE,MAAM,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IACzE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { Branch, Tenant } from '../types/tenants.js';\nimport { areBranchesQuoteCompatible, getBranchAskingVies } from './tenants.js';\n\nconst createBranch = (override?: Partial<Branch>): Branch => ({\n  id: 'TTC',\n  name: 'TTC Belgium',\n  country: 'be',\n  language: 'nl',\n  currency: 'EUR',\n  adminNumberPrefix: 'AT',\n  stockNumberPrefix: 'TC',\n  vatNumber: 'BE0123456789',\n  vatRates: { standard: '21' },\n  location: { country: 'be' },\n  ...override,\n});\n\ndescribe('areBranchesQuoteCompatible', () => {\n  it('accepts two branches that agree on country, currency, vat rate and quote mode', () => {\n    const a = createBranch();\n    const b = createBranch({ id: 'TTC2', name: 'TTC Antwerp', stockNumberPrefix: 'TA' });\n\n    expect(areBranchesQuoteCompatible(a, b)).toBe(true);\n  });\n\n  it('is true for a branch compared with itself', () => {\n    const branch = createBranch();\n\n    expect(areBranchesQuoteCompatible(branch, branch)).toBe(true);\n  });\n\n  it.each([\n    ['country', { country: 'fr' }],\n    ['currency', { currency: 'USD' }],\n    ['vat rate', { vatRates: { standard: '20' } }],\n    ['external quote mode', { externalQuote: true }],\n  ])('rejects branches that differ in %s', (_label, override) => {\n    expect(areBranchesQuoteCompatible(createBranch(), createBranch(override))).toBe(false);\n  });\n\n  it('treats a missing externalQuote as false rather than as a difference', () => {\n    const implicit = createBranch();\n    const explicit = createBranch({ externalQuote: false });\n\n    expect(areBranchesQuoteCompatible(implicit, explicit)).toBe(true);\n  });\n});\n\ndescribe('getBranchAskingVies', () => {\n  const bolivia = createBranch({ id: 'BO', country: 'bo', vatNumber: '387032026' });\n  const belgium = createBranch({ id: 'BE', country: 'be', vatNumber: 'BE0405567886' });\n  const france = createBranch({ id: 'FR', country: 'fr', vatNumber: 'FR10821739638' });\n  const tenantOf = (branches: Branch[]) => ({ branches }) as Tenant;\n\n  test.each([\n    ['the European branch the check is made for', 'FR', 'FR'],\n    ['the first European branch when no branch is given', undefined, 'BE'],\n    ['the first European branch when the given branch is outside the EU', 'BO', 'BE'],\n    ['the first European branch when the given branch is unknown', 'GONE', 'BE'],\n  ])('picks %s', (_label, branchId, expected) => {\n    expect(getBranchAskingVies(tenantOf([bolivia, belgium, france]), branchId)?.id).toBe(expected);\n  });\n\n  test('asks anonymously for a tenant without a European branch', () => {\n    expect(getBranchAskingVies(tenantOf([bolivia]), 'BO')).toBeUndefined();\n  });\n});\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bisondesk/core-sdk",
-  "version": "1.0.676",
+  "version": "1.0.678",
   "description": "",
   "type": "module",
   "author": "TheTruckCompany",

package/src/apis/organization-bank-accounts.ts

@@ -0,0 +1,123 @@
+import { SERVICE_ID_ADMIN_HEADER, TENANT_ID_ADMIN_HEADER } from '@bisondesk/commons-sdk/constants';
+import { XError } from '@bisondesk/commons-sdk/errors';
+import { cleanHeaders, getAdminAuth } from '@bisondesk/commons-sdk/fetch';
+import { DataRecord } from '@bisondesk/commons-sdk/utils';
+import fetch, { Response } from 'node-fetch';
+import {
+  NewOrganizationBankAccount,
+  OrganizationBankAccount,
+  OrganizationBankAccountMeta,
+} from '../types/organization-bank-accounts.js';
+
+type ServiceOptions = { serviceId?: string };
+
+/**
+ * Calls an organisation bank-account route as a service. The service id becomes the user core
+ * records as having made the change.
+ */
+const callBankAccountsRoute = async (
+  tenantId: string,
+  path: string,
+  init: { method: string; body?: unknown },
+  opts?: ServiceOptions,
+): Promise<Response> => {
+  const auth = await getAdminAuth();
+  const url = `${process.env.CORE_API_ORIGIN}${path}`;
+  const response: Response = await fetch(url, {
+    method: init.method,
+    headers: cleanHeaders({
+      Authorization: auth,
+      'Content-Type': init.body != null ? 'application/json' : undefined,
+      [TENANT_ID_ADMIN_HEADER]: tenantId,
+      [SERVICE_ID_ADMIN_HEADER]: opts?.serviceId,
+    }),
+    body: init.body != null ? JSON.stringify(init.body) : undefined,
+  });
+  if (!response.ok) {
+    const body = await response.text();
+    throw new XError(response.statusText, { method: init.method, url, body, tenantId, opts });
+  }
+  return response;
+};
+
+const bankAccountsPath = (organizationId: string) =>
+  `/api/crm/organizations/${organizationId}/bank-accounts`;
+
+/** An organisation's bank accounts, the default first. */
+export const listOrganizationBankAccounts = async (
+  tenantId: string,
+  organizationId: string,
+  opts?: ServiceOptions,
+): Promise<OrganizationBankAccount[]> => {
+  const response = await callBankAccountsRoute(
+    tenantId,
+    bankAccountsPath(organizationId),
+    { method: 'GET' },
+    opts,
+  );
+  const records = (await response.json()) as DataRecord<
+    OrganizationBankAccount,
+    OrganizationBankAccountMeta
+  >[];
+  return records.map((entry) => entry.record);
+};
+
+export const createOrganizationBankAccount = async (
+  tenantId: string,
+  input: NewOrganizationBankAccount,
+  opts?: ServiceOptions,
+): Promise<OrganizationBankAccount> => {
+  const { organizationId, ...details } = input;
+  const response = await callBankAccountsRoute(
+    tenantId,
+    bankAccountsPath(organizationId),
+    { method: 'POST', body: details },
+    opts,
+  );
+  return (await response.json()) as OrganizationBankAccount;
+};
+
+export const updateOrganizationBankAccount = async (
+  tenantId: string,
+  bankAccountId: string,
+  input: NewOrganizationBankAccount,
+  opts?: ServiceOptions,
+): Promise<OrganizationBankAccount> => {
+  const { organizationId, ...details } = input;
+  const response = await callBankAccountsRoute(
+    tenantId,
+    `${bankAccountsPath(organizationId)}/${bankAccountId}`,
+    { method: 'PUT', body: details },
+    opts,
+  );
+  return (await response.json()) as OrganizationBankAccount;
+};
+
+export const deleteOrganizationBankAccount = async (
+  tenantId: string,
+  organizationId: string,
+  bankAccountId: string,
+  opts?: ServiceOptions,
+): Promise<void> => {
+  await callBankAccountsRoute(
+    tenantId,
+    `${bankAccountsPath(organizationId)}/${bankAccountId}`,
+    { method: 'DELETE' },
+    opts,
+  );
+};
+
+export const setDefaultOrganizationBankAccount = async (
+  tenantId: string,
+  organizationId: string,
+  bankAccountId: string,
+  opts?: ServiceOptions,
+): Promise<OrganizationBankAccount> => {
+  const response = await callBankAccountsRoute(
+    tenantId,
+    `${bankAccountsPath(organizationId)}/${bankAccountId}/default`,
+    { method: 'POST' },
+    opts,
+  );
+  return (await response.json()) as OrganizationBankAccount;
+};

package/src/types/opportunities.ts

@@ -604,6 +604,7 @@ export type HpLeasingContractRequest = {
     vanCourier: boolean;
     startDate: number;
     opportunityContractId: string;
+    maxKmPerYear?: number;
     data: {
       leasingParameter: {
         allRisksPercentage: number;

package/src/types/organization-bank-accounts.ts

@@ -0,0 +1,56 @@
+import { BankAccountDetails } from '@bisondesk/commons-sdk/bank-accounts';
+
+/**
+ * An accountant's confirmation of one account number. It only counts while the account still
+ * holds that number, so trust never carries over to a new number however the account was edited.
+ */
+export type OrganizationBankAccountVerification = {
+  accountNumber: string;
+  verifiedBy: string;
+  verifiedAt: string;
+};
+
+export enum OrganizationBankAccountActions {
+  VERIFY = 'verify',
+}
+
+export enum OrganizationBankAccountActionBlockerCode {
+  CHANGED_NEEDS_VERIFICATION = 'changed_needs_verification',
+}
+
+export type OrganizationBankAccountActionBlocker = {
+  code: OrganizationBankAccountActionBlockerCode;
+};
+
+/**
+ * Why an action the user would otherwise see is refused right now. A missing permission hides the
+ * action instead.
+ */
+export type OrganizationBankAccountBlockedAction = {
+  action: OrganizationBankAccountActions;
+  reasons: OrganizationBankAccountActionBlocker[];
+};
+
+export type OrganizationBankAccountMeta = {
+  blockedActions: OrganizationBankAccountBlockedAction[];
+};
+
+export type NewOrganizationBankAccount = BankAccountDetails & {
+  organizationId: string;
+};
+
+/**
+ * An organisation's bank account for outgoing SEPA transfers, never shared across companies. An
+ * organisation can hold several; at most one is its `default`, the one payment exports pay to.
+ * Editing the account number or holder name clears the manual verification, so a valid checksum is
+ * never mistaken for a confirmed account holder.
+ */
+export type OrganizationBankAccount = NewOrganizationBankAccount & {
+  id: string;
+  default?: boolean;
+  createdAt: string;
+  createdBy: string;
+  modifiedAt: string;
+  modifiedBy: string;
+  verification?: OrganizationBankAccountVerification;
+};

package/src/types/payment-exports.ts

@@ -0,0 +1,40 @@
+import { BankAccountDetails } from '@bisondesk/commons-sdk/bank-accounts';
+import { AttachmentValue } from '@bisondesk/commons-sdk/types';
+
+/**
+ * The transfer details of one payment, frozen at export time. A later edit to the payment or the
+ * supplier bank account must not rewrite what the sent file said, so the export keeps its own copy
+ * of every value that went into the XML. It also records the payment batch the payment was sent to
+ * processing in, so the export is a self-contained audit record even though one file can span
+ * several batches.
+ */
+export type PaymentExportLine = {
+  paymentId: string;
+  vehicleId: string;
+  amount: string;
+  creditor: BankAccountDetails;
+  paymentBatchId: string;
+  transferReference?: string;
+};
+
+export type NewPaymentExport = {
+  /** Single execution date (`yyyy-MM-dd`) written to the file's `ReqdExctnDt`. */
+  executionDate: string;
+  /** Σ of the exported line amounts (string; computed with decimal arithmetic). */
+  totalAmount: string;
+  paymentIds: string[];
+  lines: PaymentExportLine[];
+  /** The generated SEPA file, stored in S3 and re-downloadable from Processing. */
+  xmlFile: AttachmentValue;
+};
+
+/**
+ * A generated SEPA file for a selection of Processing payments, plus the frozen record of exactly what
+ * was sent. Re-downloading serves the same file and never re-exports; a payment cancelled out of the
+ * file returns to Allowed and leaves this record intact.
+ */
+export type PaymentExport = NewPaymentExport & {
+  id: string;
+  exportedAt: string;
+  exportedBy: string;
+};

package/src/types/quote-settings.ts

@@ -91,6 +91,8 @@ export type LeasingQuoteParams<P extends CountrySpecificQuoteParams = CountrySpe
       leasingDuration: number;
       leasingDepositPercentage: string;
       leasingResidualValuePercentage: string;
+      /** Seeds `leasing.maxKmPerYear` on new quotes. */
+      maxKmPerYear?: number;
     };
     costs: {
       bankDepositPercentage: string;

package/src/types/quotes.ts

@@ -91,6 +91,8 @@ export type LeasingCalculatorInput = BaseQuoteCalculatorInput & {
     interestRate: string;
     duration: number;
     contractStartDate: string;
+    /** Mileage cap the contract allows per year, in km. Printed on the quote and the contract. */
+    maxKmPerYear?: number;
   };
   bank: {
     interestRate: string;

package/src/types/tenants.ts

@@ -55,6 +55,13 @@ export enum TenantModule {
   Intercompany = 'intercompany',
   Opportunities = 'opportunities',
   Offers = 'offers',
+  /**
+   * The tenant pays suppliers through Isabel file exports (SEPA transfer files). It grants the
+   * export itself and the verification of the supplier bank accounts it pays to, and requires those
+   * account numbers to be valid IBANs. Without it, Processing payments are simply marked paid, and
+   * a bank account can hold any account number.
+   */
+  PaymentExports = 'payment_exports',
   Vehicles = 'vehicles',
   Tasks = 'tasks',
   TrackAndTrace = 'track_and_trace',

package/src/types/vehicle-purchase-payments.ts

@@ -1,9 +1,23 @@
 import { BaseEvent } from './internal-events.js';
+import { OrganizationBankAccountActions } from './organization-bank-accounts.js';
 import { SearchVehicle } from './vehicles.js';
 
 export const VEHICLE_PURCHASE_PAYMENT_ALLOWED_NOTIFICATION_ORIGIN =
   'vehicle-purchase-payment-allowed-notification';
 
+/**
+ * The stage a supplier payment sits at, driving the Unpaid/Allowed/Processing/Executed tabs.
+ * A payment only ever moves forward: an authorised payment is `allowed`; sending it to processing
+ * groups it into a payment batch and hands it to accounting (`processing`), which exports it
+ * to the Isabel bank file; marking it paid moves it to `executed`.
+ * (`unpaid` is not a stage — it is an agreed purchase with an amount still to authorise.)
+ */
+export enum PaymentStage {
+  Allowed = 'allowed',
+  Processing = 'processing',
+  Executed = 'executed',
+}
+
 export type NewVehiclePurchasePayment = {
   vehicleId: string;
   amount: string;
@@ -16,11 +30,113 @@ export type VehiclePurchasePayment = NewVehiclePurchasePayment & {
   id: string;
   createdBy: string;
   createdAt: string;
+  stage: PaymentStage;
+  /** Manual settlement priority within the Allowed tab; lower is paid first. */
+  priority: number;
+  /** Set once the payment has been exported; links it to its payment export. */
+  exportId?: string;
+  /** The payment batch this payment was sent to processing in; unset while Allowed, and on payments
+   * marked paid straight from Allowed. */
+  paymentBatchId?: string;
+  /**
+   * Supplier-facing communication that becomes the SEPA transfer's remittance information (`RmtInf`),
+   * so the supplier can reconcile the payment to an invoice. Editable while Processing and not yet
+   * exported; prefilled from the latest purchase invoice. This is not the file's per-line
+   * `EndToEndId`.
+   */
+  transferReference?: string;
+  /** Who sent the payment to processing, and when — set at the Allowed → Processing step. */
+  sentToProcessingBy?: string;
+  sentToProcessingAt?: string;
+};
+
+/**
+ * One send to processing: the Allowed payments an accountant moved to Processing together, and who
+ * sent them. The Processing tab groups its rows by batch. A batch holds no amount of its own; its
+ * total is the sum of the payments still in it.
+ */
+export type PaymentBatch = {
+  id: string;
+  createdAt: string;
+  createdBy: string;
+};
+
+/**
+ * Whether a payment's supplier can be paid in an export. Mirrors the export gate: a transfer needs a
+ * supplier bank account that carries an IBAN and holder name and has been verified. Shown as an
+ * export-blocked marker on the Processing rows, where the accountant clears it before exporting.
+ * (The invoice / pro-forma document half of the gate is not reflected here — its source is a Q3
+ * residual the backend export gate also defers.)
+ *
+ * The bank account is the supplier's default one, `bankAccountId`, which is the account an export
+ * pays. `bankAccountActions` lists what the current user may do on it, so a row can point out the
+ * accounts they can verify themselves. Once the account number or holder name changed, verify is
+ * left out for accountants, and for whichever Senior Accountant made the change (four-eyes).
+ */
+export type PaymentExportChecks = {
+  bankAccountId?: string;
+  hasBankAccount: boolean;
+  bankAccountVerified: boolean;
+  bankAccountActions: OrganizationBankAccountActions[];
 };
 
 export type VehiclePurchasePaymentBff = {
   payment: VehiclePurchasePayment;
   vehicle: SearchVehicle;
+  /** Name of the supplier organisation (`vehicle.purchase.organizationId`), resolved for display. */
+  supplierName?: string;
+  /** Export checks on the supplier bank account; filled for the Processing list only. */
+  exportChecks?: PaymentExportChecks;
+};
+
+/**
+ * A row on the Unpaid tab: an agreed purchase that still has an amount to authorise for payment.
+ * Derived from the purchase deal and the payments already authorised, not a payment record.
+ */
+export type UnpaidPurchase = {
+  vehicle: SearchVehicle;
+  /** The agreed purchase price including VAT (`deal.purchase` grossed up by `deal.purchaseVatRate`),
+   * so it matches the VAT-inclusive cost the vehicle purchase tab authorises against. */
+  purchaseAmount: string;
+  /** Sum of amounts already authorised (payments in any stage) for this vehicle. */
+  allowedAmount: string;
+  /** Sum of the authorised amounts already settled (payments in Executed) for this vehicle. */
+  paidAmount: string;
+  /** `purchaseAmount − allowedAmount`; always greater than zero for rows shown here. */
+  remainingAmount: string;
+  /** Due date of the purchase invoice. */
+  invoiceDueDate?: string;
+  /** Name of the supplier organisation (`vehicle.purchase.organizationId`), resolved for display. */
+  supplierName?: string;
+};
+
+/** Body of the export request: the Processing payments to put in one file, the paying account, and the execution date. */
+export type ExportPaymentsRequest = {
+  paymentIds: string[];
+  /** The bank account (from documents settings) to pay the file from — the file's debtor. */
+  debtorBankAccountId: string;
+  /** Single execution date (`yyyy-MM-dd`) written to `ReqdExctnDt`; defaults to today. */
+  executionDate?: string;
+};
+
+/** Body of the mark-paid request: the payments (Allowed or Processing) to settle in one call. */
+export type MarkPaymentsPaidRequest = {
+  paymentIds: string[];
+};
+
+/** Body of the send-to-processing request: the Allowed payments to send together as one batch. */
+export type SendPaymentsToProcessingRequest = {
+  paymentIds: string[];
+};
+
+/**
+ * How many rows sit behind each payment tab, for the tab counters. Executed is unbounded and has no
+ * counter, so it is left out.
+ */
+export type PurchasePaymentCounts = {
+  unpaid: number;
+  allowed: number;
+  processing: number;
 };
 
 export type VehiclePurchasePaymentCreateEvent = {

package/src/types/vehicles.ts

@@ -846,6 +846,9 @@ export type VehiclePurchase = {
     checkedInBy?: string;
   };
 
+  /** Due date of the supplier purchase invoice; editable from the payments page. */
+  invoiceDueDate?: string;
+
   deal: {
     status: VehiclePurchaseDealStatus; // partially set by the user, if there are payments then it is set automatically by the backend
     readyToDeliver?: boolean;

package/src/utils/organization-bank-accounts.ts

@@ -0,0 +1,19 @@
+import { normalizeIban } from '@bisondesk/commons-sdk/iban';
+import { OrganizationBankAccount } from '../types/organization-bank-accounts.js';
+
+/**
+ * Whether an organisation's bank account can be paid: it carries a verification, and that
+ * verification was given for the account number the account holds now. A verification recorded
+ * without an account number, or for a different one, does not count.
+ *
+ * Shared so the export gate and the Processing rows read one rule.
+ */
+export const isOrganizationBankAccountVerified = (
+  account: OrganizationBankAccount | undefined,
+): boolean => {
+  const verifiedAccountNumber = account?.verification?.accountNumber;
+  if (account == null || verifiedAccountNumber == null) {
+    return false;
+  }
+  return normalizeIban(verifiedAccountNumber) === normalizeIban(account.accountNumber);
+};

package/src/utils/tenants.test.ts

@@ -1,5 +1,5 @@
-import { Branch } from '../types/tenants.js';
-import { areBranchesQuoteCompatible } from './tenants.js';
+import { Branch, Tenant } from '../types/tenants.js';
+import { areBranchesQuoteCompatible, getBranchAskingVies } from './tenants.js';
 
 const createBranch = (override?: Partial<Branch>): Branch => ({
   id: 'TTC',
@@ -45,3 +45,23 @@ describe('areBranchesQuoteCompatible', () => {
     expect(areBranchesQuoteCompatible(implicit, explicit)).toBe(true);
   });
 });
+
+describe('getBranchAskingVies', () => {
+  const bolivia = createBranch({ id: 'BO', country: 'bo', vatNumber: '387032026' });
+  const belgium = createBranch({ id: 'BE', country: 'be', vatNumber: 'BE0405567886' });
+  const france = createBranch({ id: 'FR', country: 'fr', vatNumber: 'FR10821739638' });
+  const tenantOf = (branches: Branch[]) => ({ branches }) as Tenant;
+
+  test.each([
+    ['the European branch the check is made for', 'FR', 'FR'],
+    ['the first European branch when no branch is given', undefined, 'BE'],
+    ['the first European branch when the given branch is outside the EU', 'BO', 'BE'],
+    ['the first European branch when the given branch is unknown', 'GONE', 'BE'],
+  ])('picks %s', (_label, branchId, expected) => {
+    expect(getBranchAskingVies(tenantOf([bolivia, belgium, france]), branchId)?.id).toBe(expected);
+  });
+
+  test('asks anonymously for a tenant without a European branch', () => {
+    expect(getBranchAskingVies(tenantOf([bolivia]), 'BO')).toBeUndefined();
+  });
+});

package/src/utils/tenants.ts

@@ -1,4 +1,5 @@
 import { XError } from '@bisondesk/commons-sdk/errors';
+import { isEUCountry } from '@bisondesk/commons-sdk/locations';
 import { first } from 'lodash-es';
 import { Branch, Tenant } from '../types/tenants.js';
 
@@ -13,6 +14,16 @@ export const getBranch = (tenant: Tenant, branchId: string): Branch => {
 
 export const getDefaultBranch = (tenant: Tenant): Branch => first(tenant.branches)!;
 
+/**
+ * The branch whose VAT number VIES records as the requester of a VAT check, which earns a
+ * consultation number: the branch the check is made for when it is European, else the tenant's
+ * first European branch. A tenant without a European branch asks VIES anonymously.
+ */
+export const getBranchAskingVies = (tenant: Tenant, branchId?: string): Branch | undefined => {
+  const europeanBranches = tenant.branches.filter((branch) => isEUCountry(branch.country));
+  return europeanBranches.find((branch) => branch.id === branchId) ?? europeanBranches.at(0);
+};
+
 /** The source invoices the end customer directly; this branch collects payment and earns
  * commission (see {@link Branch.dropshipping}). */
 export const isDropshippingBranch = (branch: Branch): boolean => branch.dropshipping === true;