@silexpert/core 1.1.397 → 1.1.400

package/ts/types/Interface/api/PaymentRecovery/Create.ts

@@ -0,0 +1,136 @@
+import { IsDateString, IsEmail, IsIBAN, IsIn, IsInt, IsOptional, IsPositive, IsPostalCode, IsString, MinLength, Validate, ValidateNested } from 'class-validator';
+import { ApiProperty, ApiPropertyOptional } from '../../../../utils';
+import { PaymentRecoveryStatus } from '../../../Enum/PaymentRecovery';
+import { IsE164PhoneNumber } from '../../../../utils/decorators/isE164PhoneNumber.decorator';
+
+type CaarlFilePayload =  {
+  bufferString: string;
+  name: string;
+};
+
+export interface UploadRecoveryDocuments {
+  subscriptionId: string;
+  files: {
+    rib: CaarlFilePayload;
+    invoice: CaarlFilePayload;
+  };
+}
+
+class DebtorPayload {
+  @ApiProperty()
+  @IsIn(['M.', 'Mme'])
+    civility: 'M.' | 'Mme'; 
+
+  @ApiProperty()
+  @IsString()
+  @MinLength(2)
+    firstname: string;
+
+  @ApiProperty()
+  @IsString()
+  @MinLength(2)
+    lastname: string;
+
+  @ApiProperty()
+  @IsEmail()
+    email: string;
+
+  @ApiProperty()
+  @Validate(IsE164PhoneNumber, { message: 'Numéro de téléphone du créancier invalide' })
+    phone: string;
+
+  @ApiProperty()
+  @IsString()
+  @MinLength(2)
+    address: string;
+
+  @ApiProperty()
+  @IsPostalCode('any')
+    zipCode: string;
+
+  @ApiProperty()
+  @IsString()
+  @MinLength(2)
+    city: string;
+
+  @ApiPropertyOptional()
+  @IsString()
+  @IsOptional()
+    legalForm?: string;
+
+  @ApiPropertyOptional()
+  @IsString()
+  @IsOptional()
+    siren?: string;
+
+  @ApiPropertyOptional()
+  @IsString()
+  @IsOptional()
+    companyName?: string;
+}
+
+class InvoicePayload {
+  @ApiProperty()
+  @IsDateString()
+    emissionDate: string;
+
+  @ApiProperty({ comment: 'Amount in cents' })
+  @IsInt()
+  @IsPositive()
+    amountTotalTaxIncluded: number;
+
+  @ApiProperty({ comment: 'Amount in cents' })
+  @IsInt()
+  @IsPositive()
+    unpaidAmountTaxIncluded: number;
+
+  @ApiProperty()
+  @IsString()
+    reference: string;
+}
+
+class CreditorPayload {
+  @ApiProperty()
+  @IsIBAN()
+    iban: string;
+
+  @ApiProperty()
+  @IsInt()
+    idRibFile: number;
+ 
+  @ApiPropertyOptional({ comment: 'Required if subscription doesn\'t have siren field' })
+  @IsString()
+  @IsOptional()
+    siren?: string | null;
+
+  @ApiProperty({ comment: 'Required if subscription doesn\'t have telephone field' })
+  @Validate(IsE164PhoneNumber, { message: 'Numéro de téléphone du créditeur invalide' })
+    phone?: string | null;
+}
+
+export class CreatePaymentRecovery {
+  @ValidateNested()
+    invoice: InvoicePayload;
+
+  @ValidateNested()
+    debtor: DebtorPayload;
+
+  @ValidateNested()
+    creditor: CreditorPayload;
+}
+
+export class AskProcessPaymentRecovery {
+  @ApiProperty()
+  @IsString()
+  @MinLength(2)
+    subject: string;
+
+  @ApiProperty()
+  @IsString()
+  @MinLength(2)
+    content: string;
+
+  @ApiProperty()
+  @IsString()
+    type: PaymentRecoveryStatus.CUSTOM_CANCELLATION | PaymentRecoveryStatus.CUSTOM_RECOVERED | 'askCertificate';
+}

package/ts/types/Interface/api/PaymentRecovery/Query.ts

@@ -0,0 +1,49 @@
+import { IsBoolean, IsDateString, IsOptional, IsString } from 'class-validator';
+import { ApiPropertyOptional } from '../../../../utils';
+import { RequiredQueryPaginate } from '../BasePaginate';
+import { ToBoolean } from '../../../../utils/transforms/boolean.transform';
+
+export class QueryPaymentRecoveryPaginated extends RequiredQueryPaginate {
+  @ApiPropertyOptional()
+  @IsBoolean()
+  @ToBoolean()
+  @IsOptional()
+    isDescending?: boolean;
+
+  @ApiPropertyOptional()
+  @IsDateString()
+  @IsOptional()
+    startDate?: string;
+
+  @ApiPropertyOptional()
+  @IsDateString()
+  @IsOptional()
+    endDate?: string;
+
+  @ApiPropertyOptional()
+  @IsString()
+  @IsOptional()
+    search?: string;
+
+  @ApiPropertyOptional()
+  @IsOptional()
+  @IsString()
+    status?: 'recovered' | 'notRecovered' | 'waiting';
+}
+
+export class QueryPaymentRecoveryStatistic {
+  @ApiPropertyOptional()
+  @IsDateString()
+  @IsOptional()
+    startDate?: string;
+
+  @ApiPropertyOptional()
+  @IsDateString()
+  @IsOptional()
+    endDate?: string;
+
+  @ApiPropertyOptional()
+  @IsString()
+  @IsOptional()
+    search?: string;
+}

package/ts/types/Interface/api/PaymentRecovery/Read.ts

@@ -0,0 +1,52 @@
+import { PaymentRecoveryStatus } from '../../../Enum/PaymentRecovery';
+import { IFile } from '../../models/IFile';
+import { IThirdParty } from '../../models/IThirdParty';
+import { CaarlEvent } from './Caarl';
+
+export interface ReadPaymentRecoveryClaim {
+  status: PaymentRecoveryStatus;
+  type: string;
+  events: CaarlEvent[];
+  iban: string;
+  debtor: {
+    firstname: string;
+    lastname: string;
+    email: string;
+    phone: string;
+    address: string;
+    zipCode: string;
+    city: string;
+  };
+}
+
+export interface ReadPaymentRecovery {
+  id: number;
+  status: PaymentRecoveryStatus;
+  externalId: string;
+  thirdParty: IThirdParty;
+  invoice: {
+    file: IFile;
+    amountTotalTaxIncluded: number;
+    amountTotalTaxExcluded: number;
+    title: string;
+    reference: string;
+  };
+  lastSync: Date | null;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export interface ReadPaymentRecoveryStatistic {
+  recovered: {
+    count: number;
+    amount: number;
+  };
+  waiting: {
+    count: number;
+    amount: number;
+  };
+  notRecovered: {
+    count: number;
+    amount: number;
+  };
+}

package/ts/types/Interface/models/IApiError.ts

@@ -9,6 +9,7 @@ export enum Code {
   tokenFailure = 'token_authentication_failure',
   authenticationFailure = 'authentication_credentials_failure',
   notFound = 'resource_not_found',
+  forbidden = 'forbidden',
   fileNotFound = 'file_not_found',
   validationError = 'resource_validation_error',
   constraintError = 'resource_constraint_error',

package/ts/types/Interface/models/IFile.ts

@@ -1,7 +1,8 @@
 import { IAttachmentFile } from './IAttachmentFile';
 import { IFolderFile } from './IFolderFile';
 import { IFileType } from './IFileType';
-import { ICommercialMail, IMail, IMailAttachment } from '../..';
+import { ICommercialMail, IEstimateInvoice, IMail, IMailAttachment } from '../..';
+import { IPaymentRecovery } from './IPaymentRecovery';
 
 // files
 export interface IFile {
@@ -21,4 +22,6 @@ export interface IFile {
   commercialMails?: ICommercialMail[];
   mails?: IMail[];
   mailAttachment?: IMailAttachment | null;
+  paymentRecovery?: IPaymentRecovery | null;
+  estimateInvoice?: IEstimateInvoice | null;
 }

package/ts/types/Interface/models/IPaymentRecovery.ts

@@ -0,0 +1,18 @@
+import { PaymentRecoveryStatus } from '../../Enum/PaymentRecovery';
+import { IFile } from './IFile';
+import { IPayment } from './IPayment';
+
+export interface IPaymentRecovery {
+  id?: number;
+  externalId: string;
+  status: PaymentRecoveryStatus;
+  lastSync: Date | null;
+  metadata: any | null;
+  idFile: number;
+  idPayment: number | null;
+  createdAt?: Date;
+  updatedAt?: Date;
+
+  file?: IFile;
+  payment?: IPayment | null;
+}

package/ts/types/index.ts

@@ -552,6 +552,7 @@ export * from './Enum/StatusRating';
 export * from './Enum/TypeSupportForNotation';
 export * from './Enum/ToRecallRating';
 export * from './Enum/PrevisionalForm';
+export * from './Enum/PaymentRecovery';
 
 // Interfaces API
 export * from './Interface/api/exercice/ReadExercice';
@@ -1102,6 +1103,10 @@ export * from './Interface/api/companyCreationForm/CreateCompanyCreationForm';
 export * from './Interface/api/companyCreationForm/UpdateCompanyCreationForm';
 export * from './Interface/api/companyCreationForm/CompanyCreationFormPayload';
 export * from './Interface/api/sellsy/CreateInvoicesSellsy';
+export * from './Interface/api/PaymentRecovery/Create';
+export * from './Interface/api/PaymentRecovery/Caarl';
+export * from './Interface/api/PaymentRecovery/Read';
+export * from './Interface/api/PaymentRecovery/Query';
 export * from './Interface/api/previsionalForm/PrevisionalFormPayload';
 export * from './Interface/api/previsionalForm/CreatePrevisionalForm';
 export * from './Interface/api/toDoExpress/Query';

package/ts/utils/brands.ts

@@ -48,6 +48,7 @@ export type Brand = {
     support?: string;
     tva?: string;
     wb?: string;
+    recovery?: string;
   },
   listPhones?: {
     contact: string;

package/ts/utils/commercialManagement/recovery.ts

@@ -0,0 +1,26 @@
+import { PaymentRecoveryStatus, PaymentRecoveryTag, Vat } from '../../types';
+
+const CARL_RECOVERY_FEES_PERCENTAGE = 15;
+const CARL_RECOVERY_REDUCED_FEES_PERCENTAGE = 10;
+const CAARL_MINIMUM_AMOUNT_FOR_REDUCED_FEES = 5001;
+
+export const CAARL_WAITING_STATUS: PaymentRecoveryStatus[] = [PaymentRecoveryStatus.OPENED, PaymentRecoveryStatus.SENT_TO_AMICABLE, PaymentRecoveryStatus.AMICABLE_SETTLEMENT, PaymentRecoveryStatus.SENT_TO_COURT, PaymentRecoveryStatus.FEES_PAID, PaymentRecoveryStatus.IP_SUBMITTED_TO_COURT, PaymentRecoveryStatus.IP_OK, PaymentRecoveryStatus.IP_SIGNIFIED, PaymentRecoveryStatus.CUSTOM_RECOVERED, PaymentRecoveryStatus.CUSTOM_CANCELLATION];
+export const CAARL_RECOVERED_STATUS: PaymentRecoveryStatus[] = [PaymentRecoveryStatus.CLOSED_PAYED];
+export const CAARL_NOT_RECOVERED_STATUS: PaymentRecoveryStatus[] = [PaymentRecoveryStatus.CLOSED_DISPUTE, PaymentRecoveryStatus.CLOSED_FAILED, PaymentRecoveryStatus.CLOSED_RJ, PaymentRecoveryStatus.CLOSED_LJ, PaymentRecoveryStatus.CLOSED_IP_KO];
+
+export function getRecoveryFeesFromAmountTotalTaxIncluded(amount: number): number {
+
+  const rate = amount >= CAARL_MINIMUM_AMOUNT_FOR_REDUCED_FEES ? CARL_RECOVERY_REDUCED_FEES_PERCENTAGE : CARL_RECOVERY_FEES_PERCENTAGE;
+
+  const feesTaxExcluded = amount * (rate / 100);
+  const feesTax = feesTaxExcluded * (Vat.TX_20.value / 100);
+
+  return feesTaxExcluded + feesTax;
+}
+
+export function getStatusGroup(status: PaymentRecoveryStatus): PaymentRecoveryTag {
+  if (CAARL_WAITING_STATUS.includes(status)) { return PaymentRecoveryTag.WAITING; }
+  if (CAARL_RECOVERED_STATUS.includes(status)) { return PaymentRecoveryTag.RECOVERED; }
+  if (CAARL_NOT_RECOVERED_STATUS.includes(status)) { return PaymentRecoveryTag.NOT_RECOVERED; }
+  return PaymentRecoveryTag.WAITING;
+}

package/ts/utils/decorators/isE164PhoneNumber.decorator.ts

@@ -0,0 +1,16 @@
+import { isDefined, ValidatorConstraint, ValidatorConstraintInterface } from 'class-validator';
+import { parsePhoneNumberFromString } from 'libphonenumber-js';
+
+
+
+@ValidatorConstraint({ name: 'isE164Phone', async: false })
+export class IsE164PhoneNumber implements ValidatorConstraintInterface {
+  validate(text: string) {
+    const phoneNumber = parsePhoneNumberFromString(text);
+    return isDefined(phoneNumber) && phoneNumber.number === text && phoneNumber.isValid();
+  }
+
+  defaultMessage() {
+    return 'Numéro de téléphone invalide';
+  }
+}