@bisondesk/documents-sdk 1.0.315

package/src/types/documents.ts

@@ -0,0 +1,251 @@
+import { BusinessEntityIds } from '@bisondesk/commons-sdk/constants';
+import { AttachmentValue, PhoneNumberValue, SearchPermissions } from '@bisondesk/commons-sdk/types';
+import { FinanceBooking, FinanceDocument } from '@bisondesk/core-sdk/types/documents';
+
+export enum AdministrativeDocType {
+  General = 'General Administrative',
+  Logistics = 'Logistics Administrative',
+  Purchase = 'Purchase Administrative',
+  Sale = 'Sale Administrative',
+}
+
+export type Association = {
+  businessEntityId: BusinessEntityIds;
+  id: string;
+  description: string;
+  tags?: string[];
+};
+
+export type FinanceDocumentLine = {
+  id: string;
+  category: string; // abstraction used to map lines to GL accounts (e.g., deposit, insurance)
+  amount: string;
+  amountExcl: string; // quantity * unit price
+  description: string;
+  foreign?: {
+    amount: string;
+    amountExcl: string;
+    unitPriceExcl: string;
+    vatAmount: string;
+  };
+  invoiceLineId?: string; // used by credit notes
+  quantity: string;
+  associations?: Association[];
+  unitPriceExcl: string;
+  vatAmount: string;
+  vatCode: string;
+  vatPercentage: string;
+  vatReason?: string;
+};
+
+type OrgSummary = {
+  id: string;
+  code: number;
+  name: string;
+  vatNumber?: string;
+
+  addressLine1?: string;
+  addressLine2?: string;
+  postcode?: string;
+  city?: string;
+  country: string;
+
+  emails?: string[];
+  phone?: PhoneNumberValue;
+
+  // TODO person name?
+  contact?: {
+    name: string;
+    username: string;
+  };
+
+  language: string; // needed?
+};
+
+export enum FinanceDocType {
+  Sale = 'Sale Finance',
+  Purchase = 'Purchase Finance',
+}
+
+export enum FinanceDocumentGenerateSubtype {
+  Invoice = 'Invoice',
+  CreditNote = 'Credit Note',
+}
+
+type BaseDocument = {
+  id: string;
+  branchId: string;
+  attachment: AttachmentValue;
+  subtype: string;
+  createdAt: string;
+  createdBy: string;
+};
+
+export type FinanceDocumentV2 = BaseDocument & {
+  version: 2.0;
+  reference: string;
+
+  type: FinanceDocType;
+
+  category: string; // abstraction used to map invoices to Journals (e.g., leasing, used trucks)
+
+  organizationSummary: OrgSummary;
+
+  dueDate?: string;
+  transferDescription?: string; // we ask clients to put this as description of the transfer
+  invoiceId?: string; // mandatory in credit notes but forbidden in invoices
+  issueDate: string;
+  lines: FinanceDocumentLine[];
+  notes?: string;
+  salesperson: {
+    name: string;
+    username: string;
+  };
+  tags: string[]; // optional values used to improve document search
+  total: {
+    amountExcl: string;
+    amount: string;
+    currencyCode: string; // from the branch
+    foreign?: {
+      amount: string;
+      amountExcl: string;
+      vatAmount: string;
+      currencyCode: string;
+      exchangeRate: string;
+    };
+    vatAmount: string;
+  };
+
+  paidAt?: string;
+};
+
+export type NewFinanceDocumentV2 = Omit<
+  FinanceDocumentV2,
+  'id' | 'createdAt' | 'createdBy' | 'lines'
+> & {
+  lines: Omit<FinanceDocumentLine, 'id'>[];
+};
+
+export type AdministrativeDocument = BaseDocument & {
+  type: AdministrativeDocType;
+  tags?: string[];
+  associations?: Association[];
+  organizationSummary?: OrgSummary;
+};
+
+export type NewAdministrativeDocument = Omit<
+  AdministrativeDocument,
+  'id' | 'createdAt' | 'createdBy'
+>;
+
+export enum DraftProcessStatus {
+  // Prefill = 'Prefill',
+  // Ready = 'Ready',
+  Error = 'Error',
+  Unprocessed = 'Unprocessed',
+  Unvalidated = 'Unvalidated',
+}
+
+type DraftProcessing = {
+  status: DraftProcessStatus;
+  businessValid: boolean;
+  accountingValid: boolean;
+  rejectedAt?: string;
+  rejectedBy?: string;
+  rejectionReason?: string;
+  failedValidationRules?: string[];
+};
+
+export enum DocumentType {
+  Finance = 'Finance Document',
+  Administrative = 'Administrative Document',
+}
+
+type BaseDocumentDraft = BaseDocument &
+  DraftProcessing & {
+    documentType?: DocumentType;
+  };
+
+export type DocumentDraft<T = FinanceDocumentV2 | AdministrativeDocument> = Partial<T> &
+  BaseDocumentDraft;
+
+export enum DraftActions {
+  Delete = 'delete',
+  Validate = 'validate',
+  Submit = 'submit',
+  ValidateBusinessRules = 'validate_business_rules',
+  ValidateAccountingRules = 'validate_accounting_rules',
+}
+
+export type RejectDraftRequest = {
+  reason?: string;
+};
+
+export type NewDocumentDraft<T = NewFinanceDocumentV2 | NewAdministrativeDocument> = Partial<T> &
+  Omit<BaseDocument, 'id' | 'createdAt' | 'createdBy' | 'subtype'> & {
+    subtype?: string;
+    documentType?: DocumentType;
+  };
+
+export type SearchFinanceDocument = {
+  doc: FinanceDocumentV2;
+  permissions: SearchPermissions;
+  booking?: FinanceBooking;
+};
+
+export type SearchAdministrativeDocument = {
+  doc: AdministrativeDocument;
+  permissions: SearchPermissions;
+};
+
+export const isFinanceDocumentV2 = (
+  arg: FinanceDocumentV2 | FinanceDocument
+): arg is FinanceDocumentV2 => {
+  return (arg as FinanceDocumentV2).version === 2;
+};
+
+export const isAdministrativeDocument = (arg: any): arg is AdministrativeDocument => {
+  return Object.values(AdministrativeDocType).includes(arg.type);
+};
+
+export const isAdministrativeDocumentDraft = (
+  draft: DocumentDraft
+): draft is DocumentDraft<AdministrativeDocument> =>
+  draft.documentType === DocumentType.Administrative;
+
+export const isFinanceDocumentDraft = (
+  arg: DocumentDraft | NewDocumentDraft
+): arg is DocumentDraft<FinanceDocumentV2> => {
+  return arg.documentType === DocumentType.Finance;
+};
+
+export type FinanceDocumentGenerateRequest = Omit<
+  FinanceDocumentV2,
+  'id' | 'attachment' | 'createdAt' | 'createdBy' | 'version' | 'reference' | 'lines' | 'subtype'
+> & {
+  subtype: FinanceDocumentGenerateSubtype;
+  lines: Omit<FinanceDocumentLine, 'id'>[];
+};
+
+// TODO
+export type DocumentGenerateRequestEvent = {
+  tenantId: string;
+  docId: string;
+  request: FinanceDocumentGenerateRequest;
+};
+
+export type FinanceDocumentSettings<M = {}> = {
+  provider: string;
+  meta: M;
+};
+
+export type FinanceDocumentBisondeskSettings = {
+  [FinanceDocumentGenerateSubtype.Invoice]: {
+    prefix: string;
+    templateId: string;
+  };
+  [FinanceDocumentGenerateSubtype.CreditNote]: {
+    prefix: string;
+    templateId: string;
+  };
+};

package/src/types/scans.ts

@@ -0,0 +1,5 @@
+export type NewDocumentScanEvent = {
+  tenantId: string;
+  source: string;
+  files: string[];
+};

package/src/types/vat.ts

@@ -0,0 +1,31 @@
+// subset of codes from UN 5305 used in Peppol
+export enum InternationalTaxCodes {
+  EeaIntraCommunity = 'K',
+  Exempt = 'E',
+  Export = 'G',
+  Margin = 'F',
+  OutsideScope = 'O',
+  ReverseCharge = 'AE',
+  Standard = 'S',
+  ZeroRated = 'Z',
+}
+
+// TODO: Add display order? Or sort by createdAt?
+export type VatCode = {
+  id: string;
+  branchId: string;
+
+  code: string; // accountingCode: string;
+  default: boolean;
+  description: string;
+  rate: string;
+  categoryCode: string; // invoiceCode: InternationalTaxCodes;
+
+  reason?: string; // legal text added when this code is used
+};
+
+export type NewVatCode = Omit<VatCode, 'id'>;
+
+export type VatCodeDefaultUpdate = {
+  id: string;
+};

package/tsconfig.cjs.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "CommonJS",
+    "target": "ES2020",
+    "outDir": "lib/cjs"
+  },
+}

package/tsconfig.esm.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "module": "ES2020",
+    "target": "ES2020",
+    "outDir": "lib/esm"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "inlineSources": true,
+    "sourceRoot": "/",
+    "composite": true,
+    "rootDir": "src",
+    "outDir": "lib",
+    "declarationDir": "lib/types"
+  },
+  "include": ["src"],
+  "references": [{ "path": "../commons-sdk" }, { "path": "../core-sdk" }]
+}