resurgence-data 1.0.22 → 1.0.23

package/src/biller/biller.dto.ts

@@ -0,0 +1,1276 @@
+import { ApiProperty } from "@nestjs/swagger";
+import {
+  IsNotEmpty,
+  IsOptional,
+  IsString,
+  IsEnum,
+  Length,
+  IsNumber,
+  IsBoolean,
+  IsUUID,
+  Max,
+  IsInt,
+  Min,
+  IsDecimal,
+  IsDateString,
+} from "class-validator";
+
+/**
+ * DTO for `BillerCategory`
+ */
+export class CreateBillerCategoryDto {
+  @ApiProperty({ description: "The name of the biller category.", example: "Utilities" })
+  @IsNotEmpty({ message: "Name is required." })
+  @IsString({ message: "Name must be a string." })
+  @Length(1, 100, { message: "Name must be between 1 and 100 characters long." })
+  name: string;
+
+  @ApiProperty({
+    description: "A description of the biller category.",
+    example: "Category for utility services like electricity and water.",
+    required: false,
+  })
+  @IsOptional()
+  @IsString({ message: "Description must be a string." })
+  description?: string;
+}
+/**
+ * DTO for `BillerCategory`
+ */
+export class UpdateBillerCategoryDto {
+  @ApiProperty({
+    description: "Unique identifier for the BillerProfile",
+    example: "e8be631d-cf95-4c9d-9d2f-91fca1da8cdb",
+  })
+  @IsUUID()
+  id: string;
+
+  @ApiProperty({ description: "The name of the biller category.", example: "Utilities" })
+  @IsNotEmpty({ message: "Name is required." })
+  @IsString({ message: "Name must be a string." })
+  @Length(1, 100, { message: "Name must be between 1 and 100 characters long." })
+  name: string;
+
+  @ApiProperty({
+    description: "A description of the biller category.",
+    example: "Category for utility services like electricity and water.",
+    required: false,
+  })
+  @IsOptional()
+  @IsString({ message: "Description must be a string." })
+  description?: string;
+}
+
+/**
+ * DTO for `Bank`
+ */
+export class CreateBankDto {
+  @ApiProperty({ description: "The name of the bank.", example: "First Bank" })
+  @IsNotEmpty({ message: "Name is required." })
+  @IsString({ message: "Name must be a string." })
+  @Length(1, 100, { message: "Name must be between 1 and 100 characters long." })
+  name: string;
+
+  @ApiProperty({ description: "The unique slug for the bank.", example: "first-bank" })
+  @IsNotEmpty({ message: "Slug is required." })
+  @IsString({ message: "Slug must be a string." })
+  @Length(1, 100, { message: "Slug must be between 1 and 100 characters long." })
+  slug: string;
+
+  @ApiProperty({ description: "The bank code.", example: "123" })
+  @IsNotEmpty({ message: "Code is required." })
+  @IsString({ message: "Code must be a string." })
+  @Length(1, 10, { message: "Code must be between 1 and 10 characters long." })
+  code: string;
+
+  @ApiProperty({ description: "The long code for the bank.", example: "123456789", required: false })
+  @IsNotEmpty({ message: "Long code is required." })
+  @IsString({ message: "Long code must be a string." })
+  @Length(1, 50, { message: "Long code must be between 1 and 50 characters long." })
+  @IsOptional()
+  longCode?: string;
+}
+
+/**
+ * DTO for `Charge`
+ */
+export class CreateChargeDto {
+  @ApiProperty({ description: "The name of the charge.", example: "Service Fee" })
+  @IsNotEmpty({ message: "Name is required." })
+  @IsString({ message: "Name must be a string." })
+  @Length(1, 100, { message: "Name must be between 1 and 100 characters long." })
+  name: string;
+
+  @ApiProperty({ description: "The type of charge.", enum: ["FIXED", "PERCENTAGE"], example: "FIXED" })
+  @IsNotEmpty({ message: "Charge type is required." })
+  @IsEnum(["FIXED", "PERCENTAGE"], { message: "Charge type must be FIXED or PERCENTAGE." })
+  type: "FIXED" | "PERCENTAGE";
+
+  @ApiProperty({ description: "The value of the charge.", example: 100 })
+  @IsNotEmpty({ message: "Value is required." })
+  @IsNumber({}, { message: "Value must be a number." })
+  value: number;
+
+  @ApiProperty({ description: "A description of the charge.", example: "Service fee for processing.", required: false })
+  @IsOptional()
+  @IsString({ message: "Description must be a string." })
+  description?: string;
+}
+
+/**
+ * DTO for `Transaction`
+ */
+export class CreateTransactionDto {
+  @ApiProperty({ description: "The amount involved in the transaction.", example: 1000 })
+  @IsNotEmpty({ message: "Amount is required." })
+  @IsNumber({}, { message: "Amount must be a number." })
+  amount: number;
+
+  @ApiProperty({ description: "The ID of the associated bank.", example: "uuid-value" })
+  @IsNotEmpty({ message: "Bank ID is required." })
+  @IsString({ message: "Bank ID must be a string." })
+  bankId: string;
+
+  @ApiProperty({ description: "The type of transaction.", enum: ["CREDIT", "DEBIT"], example: "CREDIT" })
+  @IsNotEmpty({ message: "Transaction type is required." })
+  @IsEnum(["CREDIT", "DEBIT"], { message: "Transaction type must be CREDIT or DEBIT." })
+  type: "CREDIT" | "DEBIT";
+
+  @ApiProperty({
+    description: "Remarks or notes for the transaction.",
+    example: "Payment for invoice #1234",
+    required: false,
+  })
+  @IsOptional()
+  @IsString({ message: "Remarks must be a string." })
+  remarks?: string;
+}
+
+/**
+ * DTO for `Biller`
+ */
+export class CreateBillerDto {
+  @ApiProperty({ description: "The unique ID of the biller.", example: "uuid-value" })
+  @IsOptional()
+  @IsString({ message: "ID must be a string." })
+  id?: string;
+
+  @ApiProperty({ description: "The ID of the category associated with the biller.", example: "uuid-value" })
+  @IsNotEmpty({ message: "Category ID is required." })
+  @IsString({ message: "Category ID must be a string." })
+  categoryId: string;
+
+  @ApiProperty({ description: "The ID of the profile associated with the biller.", example: "uuid-value" })
+  @IsOptional()
+  @IsString({ message: "Profile ID must be a string." })
+  billerProfileId?: string;
+
+  @ApiProperty({ description: "The name of the biller.", example: "Electricity Provider" })
+  @IsNotEmpty({ message: "Name is required." })
+  @IsString({ message: "Name must be a string." })
+  @Length(1, 50, { message: "Name must be between 1 and 50 characters long." })
+  name: string;
+
+  @ApiProperty({ description: "Whether the biller is live.", example: false })
+  @IsNotEmpty({ message: "Live status is required." })
+  @IsBoolean({ message: "Live must be a boolean." })
+  live: boolean;
+
+  @ApiProperty({ description: "Whether the biller is active.", example: false })
+  @IsNotEmpty({ message: "Active status is required." })
+  @IsBoolean({ message: "Active must be a boolean." })
+  active: boolean;
+
+  @ApiProperty({ description: "The slug for the biller.", example: "electricity-provider", required: false })
+  @IsOptional()
+  @IsString({ message: "Slug must be a string." })
+  slug?: string;
+
+  @ApiProperty({ description: "The biller code.", example: "ELEC123", required: false })
+  @IsOptional()
+  @IsString({ message: "Biller code must be a string." })
+  @Length(1, 15, { message: "Biller code must be between 1 and 15 characters long." })
+  billerCode?: string;
+
+  @ApiProperty({ description: "The creation timestamp of the biller.", example: "2025-01-01T00:00:00Z" })
+  @IsOptional()
+  @IsString({ message: "CreatedAt must be a string." })
+  createdAt?: string;
+
+  @ApiProperty({ description: "The last update timestamp of the biller.", example: "2025-01-01T00:00:00Z" })
+  @IsOptional()
+  @IsString({ message: "UpdatedAt must be a string." })
+  updatedAt?: string;
+}
+
+export class UpdateBillerDto {
+  @ApiProperty({ description: "The unique ID of the biller.", example: "uuid-value" })
+  @IsOptional()
+  @IsString({ message: "ID must be a string." })
+  id?: string;
+
+  @ApiProperty({ description: "The ID of the category associated with the biller.", example: "uuid-value" })
+  @IsString({ message: "Category ID must be a string." })
+  @IsOptional()
+  categoryId?: string;
+
+  @ApiProperty({ description: "The ID of the profile associated with the biller.", example: "uuid-value" })
+  @IsOptional()
+  @IsString({ message: "Profile ID must be a string." })
+  billerProfileId?: string;
+
+  @ApiProperty({ description: "The name of the biller.", example: "Electricity Provider", required: false })
+  @IsString({ message: "Name must be a string." })
+  @Length(1, 50, { message: "Name must be between 1 and 50 characters long." })
+  @IsOptional()
+  name?: string;
+
+  @ApiProperty({ description: "Whether the biller is live.", example: false, required: false })
+  @IsBoolean({ message: "Live must be a boolean." })
+  @IsOptional()
+  live?: boolean;
+
+  @ApiProperty({ description: "Whether the biller is active.", example: false, required: false })
+  @IsBoolean({ message: "Active must be a boolean." })
+  @IsOptional()
+  active: boolean;
+
+  @ApiProperty({ description: "The slug for the biller.", example: "electricity-provider", required: false })
+  @IsOptional()
+  @IsString({ message: "Slug must be a string." })
+  slug?: string;
+
+  @ApiProperty({ description: "The biller code.", example: "ELEC123", required: false })
+  @IsOptional()
+  @IsString({ message: "Biller code must be a string." })
+  @Length(1, 15, { message: "Biller code must be between 1 and 15 characters long." })
+  billerCode?: string;
+}
+
+export enum TIME_DELIMITER {
+  DAY = "DAY",
+  WEEK = "WEEK",
+  MONTH = "MONTH",
+}
+
+export class BillerProfileDTO {
+  @ApiProperty({
+    description: "Unique identifier for the BillerProfile",
+    example: "e8be631d-cf95-4c9d-9d2f-91fca1da8cdb",
+  })
+  @IsUUID()
+  id: string;
+
+  @ApiProperty({
+    description: "Name of the BillerProfile, max length of 50 characters",
+    example: "Test Biller",
+    required: false,
+  })
+  @IsOptional()
+  @IsString()
+  @Max(50)
+  name?: string;
+
+  @ApiProperty({
+    description: "Indicates if the BillerProfile has a transaction limit",
+    example: true,
+    required: false,
+  })
+  @IsBoolean()
+  @IsOptional()
+  hasTransactionLimit?: boolean;
+
+  @ApiProperty({
+    description: "Transaction limit value, defaults to 0",
+    example: 5000,
+    required: false,
+  })
+  @IsInt()
+  @Min(0)
+  @IsOptional()
+  transactionLimit?: number;
+
+  @ApiProperty({
+    description: "Delimiter for time intervals, such as DAY, WEEK, or MONTH",
+    enum: TIME_DELIMITER,
+    example: TIME_DELIMITER.DAY,
+    required: false,
+  })
+  @IsEnum(TIME_DELIMITER)
+  @IsOptional()
+  delimiter?: TIME_DELIMITER;
+}
+
+export class UpdateBillerProfileDTO {
+  @ApiProperty({
+    description: "Unique identifier for the BillerProfile",
+    example: "e8be631d-cf95-4c9d-9d2f-91fca1da8cdb",
+  })
+  @IsUUID()
+  id: string;
+
+  @ApiProperty({
+    description: "Name of the BillerProfile, max length of 50 characters",
+    example: "Test Biller",
+    required: false,
+  })
+  @IsOptional()
+  @IsString()
+  @Max(50)
+  name?: string;
+
+  @ApiProperty({
+    description: "Indicates if the BillerProfile has a transaction limit",
+    example: true,
+    required: false,
+  })
+  @IsBoolean()
+  @IsOptional()
+  hasTransactionLimit?: boolean;
+
+  @ApiProperty({
+    description: "Transaction limit value, defaults to 0",
+    example: 5000,
+    required: false,
+  })
+  @IsInt()
+  @Min(0)
+  @IsOptional()
+  transactionLimit?: number;
+
+  @ApiProperty({
+    description: "Delimiter for time intervals, such as DAY, WEEK, or MONTH",
+    enum: TIME_DELIMITER,
+    example: TIME_DELIMITER.DAY,
+    required: false,
+  })
+  @IsEnum(TIME_DELIMITER)
+  @IsOptional()
+  delimiter?: TIME_DELIMITER;
+}
+
+export class CreateSettlementAccountDto {
+  @ApiProperty({
+    description: "The ID of the biller",
+    example: "550e8400-e29b-41d4-a716-446655440000",
+  })
+  @IsNotEmpty({ message: "Biller ID must not be empty" })
+  @IsString({ message: "Biller ID must be a valid string" })
+  billerId: string;
+
+  @ApiProperty({
+    description: "The ID of the bank",
+    example: "550e8400-e29b-41d4-a716-446655440001",
+  })
+  @IsNotEmpty({ message: "Bank ID must not be empty" })
+  @IsString({ message: "Bank ID must be a valid string" })
+  bankId: string;
+
+  @ApiProperty({
+    description: "Whether the account is the default account",
+    example: false,
+  })
+  @IsBoolean({ message: "Default must be a boolean value" })
+  @IsOptional()
+  default?: boolean;
+
+  @ApiProperty({
+    description: "The name of the account",
+    example: "John Doe",
+  })
+  @IsNotEmpty({ message: "Account name must not be empty" })
+  @IsString({ message: "Account name must be a valid string" })
+  @Length(1, 50, { message: "Account name must be between 1 and 50 characters" })
+  accountName: string;
+
+  @ApiProperty({
+    description: "The account number",
+    example: "123456789012345",
+  })
+  @IsNotEmpty({ message: "Account number must not be empty" })
+  @IsString({ message: "Account number must be a valid string" })
+  @Length(10, 15, { message: "Account number must be between 10 and 15 characters" })
+  accountNumber: string;
+
+  @ApiProperty({
+    description: "The currency of the account",
+    example: "NGN",
+  })
+  @IsNotEmpty({ message: "Currency must not be empty" })
+  @IsString({ message: "Currency must be a valid string" })
+  @Length(3, 5, { message: "Currency must be between 3 and 5 characters" })
+  currency: string;
+}
+
+export class UpdateSettlementAccountDto {
+  @IsNotEmpty({ message: "ID must be provided" })
+  @IsString({ message: "ID must be a valid string" })
+  @IsUUID()
+  id: string;
+
+  @ApiProperty({
+    description: "The ID of the biller",
+    example: "550e8400-e29b-41d4-a716-446655440000",
+    required: false,
+  })
+  @IsString({ message: "Biller ID must be a valid string" })
+  @IsOptional()
+  billerId?: string;
+
+  @ApiProperty({
+    description: "The ID of the bank",
+    example: "550e8400-e29b-41d4-a716-446655440001",
+    required: false,
+  })
+  @IsString({ message: "Bank ID must be a valid string" })
+  @IsOptional()
+  bankId?: string;
+
+  @ApiProperty({
+    description: "Whether the account is the default account",
+    example: false,
+    required: false,
+  })
+  @IsBoolean({ message: "Default must be a boolean value" })
+  @IsOptional()
+  default?: boolean;
+
+  @ApiProperty({
+    description: "The name of the account",
+    example: "John Doe",
+    required: false,
+  })
+  @IsString({ message: "Account name must be a valid string" })
+  @Length(1, 50, { message: "Account name must be between 1 and 50 characters" })
+  @IsOptional()
+  accountName?: string;
+
+  @ApiProperty({
+    description: "The account number",
+    example: "123456789012345",
+    required: false,
+  })
+  @IsString({ message: "Account number must be a valid string" })
+  @Length(10, 15, { message: "Account number must be between 10 and 15 characters" })
+  @IsOptional()
+  accountNumber?: string;
+
+  @ApiProperty({
+    description: "The currency of the account",
+    example: "NGN",
+    required: false,
+  })
+  @IsString({ message: "Currency must be a valid string" })
+  @Length(3, 5, { message: "Currency must be between 3 and 5 characters" })
+  @IsOptional()
+  currency?: string;
+}
+
+export class CreateBillerChargeConfigurationDto {
+  @ApiProperty({
+    description: "The ID of the service",
+    example: "550e8400-e29b-41d4-a716-446655440001",
+  })
+  @IsNotEmpty({ message: "Service ID must not be empty" })
+  @IsString({ message: "Service ID must be a valid string" })
+  serviceId: string;
+
+  @ApiProperty({
+    description: "Whether the configuration is active",
+    example: false,
+  })
+  @IsBoolean({ message: "Active must be a boolean value" })
+  @IsOptional()
+  active?: boolean;
+
+  @ApiProperty({
+    description: "Whether the charge is capped",
+    example: false,
+  })
+  @IsBoolean({ message: "Capped must be a boolean value" })
+  @IsOptional()
+  capped?: boolean;
+
+  @ApiProperty({
+    description: "Whether the charge is floored",
+    example: false,
+  })
+  @IsBoolean({ message: "Floored must be a boolean value" })
+  @IsOptional()
+  floored?: boolean;
+
+  @ApiProperty({
+    description: "The cap for the charge",
+    example: 1000,
+  })
+  @IsInt({ message: "Charge cap must be an integer value" })
+  @Min(0, { message: "Charge cap must not be negative" })
+  @IsOptional()
+  chargeCap?: number;
+
+  @ApiProperty({
+    description: "The floor for the charge",
+    example: 100,
+  })
+  @IsInt({ message: "Charge floor must be an integer value" })
+  @Min(0, { message: "Charge floor must not be negative" })
+  @IsOptional()
+  chargeFloor?: number;
+
+  @ApiProperty({
+    description: "The currency of the charge",
+    example: "NGN",
+  })
+  @IsNotEmpty({ message: "Currency must not be empty" })
+  @IsString({ message: "Currency must be a valid string" })
+  @Length(3, 4, { message: "Currency must be between 3 and 4 characters" })
+  currency: string;
+
+  @ApiProperty({
+    description: "The type of the charge",
+    example: "FIXED",
+  })
+  @IsNotEmpty({ message: "Charge type must not be empty" })
+  @IsString({ message: "Charge type must be a valid string" })
+  chargeType: string;
+
+  @ApiProperty({
+    description: "The fixed amount of the charge",
+    example: 500,
+  })
+  @IsInt({ message: "Fixed amount must be an integer value" })
+  @Min(0, { message: "Fixed amount must not be negative" })
+  @IsOptional()
+  fixedAmount?: number;
+
+  @ApiProperty({
+    description: "The percentage amount of the charge",
+    example: 5.5,
+  })
+  @IsDecimal(
+    { decimal_digits: "1,2", force_decimal: false },
+    { message: "Percent amount must be a valid decimal with up to 2 decimal places" }
+  )
+  @Min(0, { message: "Percent amount must not be negative" })
+  @IsOptional()
+  percentAmount?: number;
+}
+
+export class UpdateBillerChargeConfigurationDto {
+  @IsNotEmpty({ message: "ID must be provided" })
+  @IsString({ message: "ID must be a valid string" })
+  @IsUUID()
+  id: string;
+
+  @ApiProperty({
+    description: "The ID of the service",
+    example: "550e8400-e29b-41d4-a716-446655440001",
+    required: false,
+  })
+  @IsString({ message: "Service ID must be a valid string" })
+  @IsOptional()
+  serviceId?: string;
+
+  @ApiProperty({
+    description: "Whether the configuration is active",
+    example: false,
+    required: false,
+  })
+  @IsBoolean({ message: "Active must be a boolean value" })
+  @IsOptional()
+  active?: boolean;
+
+  @ApiProperty({
+    description: "Whether the charge is capped",
+    example: false,
+    required: false,
+  })
+  @IsBoolean({ message: "Capped must be a boolean value" })
+  @IsOptional()
+  capped?: boolean;
+
+  @ApiProperty({
+    description: "Whether the charge is floored",
+    example: false,
+    required: false,
+  })
+  @IsBoolean({ message: "Floored must be a boolean value" })
+  @IsOptional()
+  floored?: boolean;
+
+  @ApiProperty({
+    description: "The cap for the charge",
+    example: 1000,
+    required: false,
+  })
+  @IsInt({ message: "Charge cap must be an integer value" })
+  @Min(0, { message: "Charge cap must not be negative" })
+  @IsOptional()
+  chargeCap?: number;
+
+  @ApiProperty({
+    description: "The floor for the charge",
+    example: 100,
+    required: false,
+  })
+  @IsInt({ message: "Charge floor must be an integer value" })
+  @Min(0, { message: "Charge floor must not be negative" })
+  @IsOptional()
+  chargeFloor?: number;
+
+  @ApiProperty({
+    description: "The currency of the charge",
+    example: "NGN",
+    required: false,
+  })
+  @IsString({ message: "Currency must be a valid string" })
+  @Length(3, 4, { message: "Currency must be between 3 and 4 characters" })
+  @IsOptional()
+  currency?: string;
+
+  @ApiProperty({
+    description: "The type of the charge",
+    example: "FIXED",
+    required: false,
+  })
+  @IsString({ message: "Charge type must be a valid string" })
+  @IsOptional()
+  chargeType?: string;
+
+  @ApiProperty({
+    description: "The fixed amount of the charge",
+    example: 500,
+    required: false,
+  })
+  @IsInt({ message: "Fixed amount must be an integer value" })
+  @Min(0, { message: "Fixed amount must not be negative" })
+  @IsOptional()
+  fixedAmount?: number;
+
+  @ApiProperty({
+    description: "The percentage amount of the charge",
+    example: 5.5,
+    required: false,
+  })
+  @IsDecimal(
+    { decimal_digits: "1,2", force_decimal: false },
+    { message: "Percent amount must be a valid decimal with up to 2 decimal places" }
+  )
+  @Min(0, { message: "Percent amount must not be negative" })
+  @IsOptional()
+  percentAmount?: number;
+}
+
+export class CreateBillerDocumentDto {
+  @ApiProperty({
+    description: "The ID of the biller",
+    example: "550e8400-e29b-41d4-a716-446655440002",
+  })
+  @IsNotEmpty({ message: "Biller ID must not be empty" })
+  @IsString({ message: "Biller ID must be a valid string" })
+  billerId: string;
+
+  @ApiProperty({
+    description: "The URL of the document",
+    example: "https://example.com/document.pdf",
+  })
+  @IsNotEmpty({ message: "URL must not be empty" })
+  @IsString({ message: "URL must be a valid string" })
+  url: string;
+
+  @ApiProperty({
+    description: "The type of the document",
+    example: "CONTRACT",
+  })
+  @IsNotEmpty({ message: "Document type must not be empty" })
+  @IsString({ message: "Document type must be a valid string" })
+  type: string;
+}
+
+export class UpdateBillerDocumentDto {
+  @ApiProperty({
+    description: "The ID of the biller",
+    example: "550e8400-e29b-41d4-a716-446655440002",
+    required: false,
+  })
+  @IsString({ message: "Biller ID must be a valid string" })
+  @IsOptional()
+  billerId?: string;
+
+  @ApiProperty({
+    description: "The URL of the document",
+    example: "https://example.com/document.pdf",
+    required: false,
+  })
+  @IsString({ message: "URL must be a valid string" })
+  @IsOptional()
+  url?: string;
+
+  @ApiProperty({
+    description: "The type of the document",
+    example: "CONTRACT",
+    required: false,
+  })
+  @IsString({ message: "Document type must be a valid string" })
+  @IsOptional()
+  type?: string;
+}
+
+export class CreateGoLiveRequestDto {
+  @ApiProperty({
+    description: "The ID of the biller",
+    example: "550e8400-e29b-41d4-a716-446655440003",
+  })
+  @IsNotEmpty({ message: "Biller ID must not be empty" })
+  @IsString({ message: "Biller ID must be a valid string" })
+  billerId: string;
+
+  @ApiProperty({
+    description: "The status of the go-live request",
+    example: "PENDING",
+  })
+  @IsNotEmpty({ message: "Status must not be empty" })
+  @IsString({ message: "Status must be a valid string" })
+  status: string;
+}
+
+export class UpdateGoLiveRequestDto {
+  @ApiProperty({
+    description: "The ID of the biller",
+    example: "550e8400-e29b-41d4-a716-446655440003",
+    required: false,
+  })
+  @IsString({ message: "Biller ID must be a valid string" })
+  @IsOptional()
+  billerId?: string;
+
+  @ApiProperty({
+    description: "The status of the go-live request",
+    example: "PENDING",
+    required: false,
+  })
+  @IsString({ message: "Status must be a valid string" })
+  @IsOptional()
+  status?: string;
+}
+
+export class CreateBillerContactDto {
+  @ApiProperty({
+    description: "The ID of the biller",
+    example: "550e8400-e29b-41d4-a716-446655440000",
+  })
+  @IsNotEmpty({ message: "Biller ID must not be empty" })
+  @IsString({ message: "Biller ID must be a valid string" })
+  billerId: string;
+
+  @ApiProperty({
+    description: "The name of the contact",
+    example: "John Doe",
+  })
+  @IsNotEmpty({ message: "Contact name must not be empty" })
+  @IsString({ message: "Contact name must be a valid string" })
+  @Length(1, 50, { message: "Contact name must be between 1 and 50 characters" })
+  contactName: string;
+
+  @ApiProperty({
+    description: "The email address of the contact",
+    example: "johndoe@example.com",
+  })
+  @IsNotEmpty({ message: "Email address must not be empty" })
+  @IsString({ message: "Email address must be a valid string" })
+  @Length(1, 50, { message: "Email address must be between 1 and 50 characters" })
+  emailAddress: string;
+
+  @ApiProperty({
+    description: "The phone number of the contact",
+    example: "+1234567890",
+    required: false,
+  })
+  @IsString({ message: "Phone number must be a valid string" })
+  @IsOptional()
+  phoneNumber?: string;
+
+  @ApiProperty({
+    description: "The date of birth of the contact",
+    example: "1990-01-01T00:00:00.000Z",
+  })
+  @IsNotEmpty({ message: "Date of birth must not be empty" })
+  @IsDateString({}, { message: "Date of birth must be a valid ISO 8601 date string" })
+  dob: string;
+
+  @ApiProperty({
+    description: "The address of the contact",
+    example: "123 Main St, Anytown",
+  })
+  @IsNotEmpty({ message: "Address must not be empty" })
+  @IsString({ message: "Address must be a valid string" })
+  address: string;
+
+  @ApiProperty({
+    description: "The country of the contact",
+    example: "USA",
+  })
+  @IsNotEmpty({ message: "Country must not be empty" })
+  @IsString({ message: "Country must be a valid string" })
+  @Length(1, 50, { message: "Country must be between 1 and 50 characters" })
+  country: string;
+
+  @ApiProperty({
+    description: "The city of the contact",
+    example: "New York",
+  })
+  @IsNotEmpty({ message: "City must not be empty" })
+  @IsString({ message: "City must be a valid string" })
+  @Length(1, 50, { message: "City must be between 1 and 50 characters" })
+  city: string;
+
+  @ApiProperty({
+    description: "The state of the contact",
+    example: "NY",
+  })
+  @IsNotEmpty({ message: "State must not be empty" })
+  @IsString({ message: "State must be a valid string" })
+  @Length(1, 50, { message: "State must be between 1 and 50 characters" })
+  state: string;
+}
+
+export class UpdateBillerContactDto {
+  @ApiProperty({
+    description: "The ID of the contact",
+    example: "550e8400-e29b-41d4-a716-446655440000",
+  })
+  @IsNotEmpty({ message: "ID must not be empty" })
+  @IsString({ message: "ID must be a valid string" })
+  id: string;
+
+  @ApiProperty({
+    description: "The ID of the biller",
+    example: "550e8400-e29b-41d4-a716-446655440000",
+    required: false,
+  })
+  @IsNotEmpty({ message: "Biller ID must not be empty" })
+  @IsString({ message: "Biller ID must be a valid string" })
+  @IsOptional()
+  billerId?: string;
+
+  @ApiProperty({
+    description: "The name of the contact",
+    example: "John Doe",
+    required: false,
+  })
+  @IsString({ message: "Contact name must be a valid string" })
+  @Length(1, 50, { message: "Contact name must be between 1 and 50 characters" })
+  @IsOptional()
+  contactName?: string;
+
+  @ApiProperty({
+    description: "The email address of the contact",
+    example: "johndoe@example.com",
+    required: false,
+  })
+  @IsString({ message: "Email address must be a valid string" })
+  @Length(1, 50, { message: "Email address must be between 1 and 50 characters" })
+  @IsOptional()
+  emailAddress?: string;
+
+  @ApiProperty({
+    description: "The phone number of the contact",
+    example: "+1234567890",
+    required: false,
+  })
+  @IsString({ message: "Phone number must be a valid string" })
+  @IsOptional()
+  phoneNumber?: string;
+
+  @ApiProperty({
+    description: "The date of birth of the contact",
+    example: "1990-01-01T00:00:00.000Z",
+    required: false,
+  })
+  @IsDateString({}, { message: "Date of birth must be a valid ISO 8601 date string" })
+  @IsOptional()
+  dob?: string;
+
+  @ApiProperty({
+    description: "The address of the contact",
+    example: "123 Main St, Anytown",
+    required: false,
+  })
+  @IsString({ message: "Address must be a valid string" })
+  @IsOptional()
+  address?: string;
+
+  @ApiProperty({
+    description: "The country of the contact",
+    example: "USA",
+    required: false,
+  })
+  @IsString({ message: "Country must be a valid string" })
+  @Length(1, 50, { message: "Country must be between 1 and 50 characters" })
+  @IsOptional()
+  country?: string;
+
+  @ApiProperty({
+    description: "The city of the contact",
+    example: "New York",
+    required: false,
+  })
+  @IsString({ message: "City must be a valid string" })
+  @Length(1, 50, { message: "City must be between 1 and 50 characters" })
+  @IsOptional()
+  city?: string;
+
+  @ApiProperty({
+    description: "The state of the contact",
+    example: "NY",
+    required: false,
+  })
+  @IsString({ message: "State must be a valid string" })
+  @Length(1, 50, { message: "State must be between 1 and 50 characters" })
+  @IsOptional()
+  state?: string;
+}
+
+export class CreateCustomerDto {
+  @ApiProperty({
+    description: "The ID of the biller",
+    example: "550e8400-e29b-41d4-a716-446655440000",
+  })
+  @IsNotEmpty({ message: "Biller ID must not be empty" })
+  @IsString({ message: "Biller ID must be a valid string" })
+  billerId: string;
+
+  @ApiProperty({
+    description: "The name of the customer",
+    example: "Jane Smith",
+  })
+  @IsNotEmpty({ message: "Name must not be empty" })
+  @IsString({ message: "Name must be a valid string" })
+  @Length(1, 50, { message: "Name must be between 1 and 50 characters" })
+  name: string;
+
+  @ApiProperty({
+    description: "The email address of the customer",
+    example: "janesmith@example.com",
+    required: false,
+  })
+  @IsString({ message: "Email address must be a valid string" })
+  @Length(1, 50, { message: "Email address must be between 1 and 50 characters" })
+  @IsOptional()
+  emailAddress?: string;
+
+  @ApiProperty({
+    description: "The phone number of the customer",
+    example: "+9876543210",
+    required: false,
+  })
+  @IsString({ message: "Phone number must be a valid string" })
+  @IsOptional()
+  phoneNumber?: string;
+}
+
+export class UpdateCustomerDto {
+  @ApiProperty({
+    description: "The ID of the customer",
+    example: "550e8400-e29b-41d4-a716-446655440000",
+  })
+  @IsNotEmpty({ message: "ID must not be empty" })
+  @IsString({ message: "ID must be a valid string" })
+  id: string;
+
+  @ApiProperty({
+    description: "The name of the customer",
+    example: "Jane Smith",
+    required: false,
+  })
+  @IsString({ message: "Name must be a valid string" })
+  @Length(1, 50, { message: "Name must be between 1 and 50 characters" })
+  @IsOptional()
+  name?: string;
+
+  @ApiProperty({
+    description: "The email address of the customer",
+    example: "janesmith@example.com",
+    required: false,
+  })
+  @IsString({ message: "Email address must be a valid string" })
+  @Length(1, 50, { message: "Email address must be between 1 and 50 characters" })
+  @IsOptional()
+  emailAddress?: string;
+
+  @ApiProperty({
+    description: "The phone number of the customer",
+    example: "+9876543210",
+    required: false,
+  })
+  @IsString({ message: "Phone number must be a valid string" })
+  @IsOptional()
+  phoneNumber?: string;
+}
+
+export class CreateBillerItemDto {
+  @ApiProperty({
+    description: "The ID of the biller",
+    example: "550e8400-e29b-41d4-a716-446655440000",
+  })
+  @IsNotEmpty({ message: "Biller ID must not be empty" })
+  @IsString({ message: "Biller ID must be a valid string" })
+  billerId: string;
+
+  @ApiProperty({
+    description: "The amount associated with the biller item",
+    example: 100,
+  })
+  @IsInt({ message: "Amount must be a valid integer" })
+  @IsNotEmpty({ message: "Amount must not be empty" })
+  amount: number;
+
+  @ApiProperty({
+    description: "The source of the biller item",
+    example: "Utility Bill",
+    required: false,
+  })
+  @IsString({ message: "Source must be a valid string" })
+  @IsOptional()
+  source?: string;
+
+  @ApiProperty({
+    description: "The customer identifier name for the biller item",
+    example: "Customer ID",
+    required: false,
+  })
+  @IsString({ message: "Customer identifier name must be a valid string" })
+  @IsOptional()
+  customerIdentifierName?: string;
+
+  @ApiProperty({
+    description: "The service fee associated with the biller item",
+    example: 10,
+  })
+  @IsInt({ message: "Service fee must be a valid integer" })
+  @IsNotEmpty({ message: "Service fee must not be empty" })
+  serviceFee: number;
+
+  @ApiProperty({
+    description: "The currency of the biller item",
+    example: "NGN",
+  })
+  @IsString({ message: "Currency must be a valid string" })
+  @Length(1, 4, { message: "Currency must be between 1 and 4 characters" })
+  @IsNotEmpty({ message: "Currency must not be empty" })
+  currency: string;
+
+  @ApiProperty({
+    description: "The description of the biller item",
+    example: "Electricity Bill Payment",
+    required: false,
+  })
+  @IsString({ message: "Description must be a valid string" })
+  @IsOptional()
+  description?: string;
+
+  @ApiProperty({
+    description: "Indicates if the biller item is external",
+    example: false,
+  })
+  @IsBoolean({ message: "External must be a valid boolean" })
+  @IsNotEmpty({ message: "External must not be empty" })
+  external: boolean;
+}
+
+export class UpdateBillerItemDto {
+  @ApiProperty({
+    description: "The ID of the biller item",
+    example: "550e8400-e29b-41d4-a716-446655440000",
+  })
+  @IsNotEmpty({ message: "ID must not be empty" })
+  @IsString({ message: "ID must be a valid string" })
+  id: string;
+
+  @ApiProperty({
+    description: "The ID of the biller",
+    example: "550e8400-e29b-41d4-a716-446655440000",
+    required: false,
+  })
+  @IsNotEmpty({ message: "Biller ID must not be empty" })
+  @IsString({ message: "Biller ID must be a valid string" })
+  billerId?: string;
+
+  @ApiProperty({
+    description: "The amount associated with the biller item",
+    example: 100,
+    required: false,
+  })
+  @IsInt({ message: "Amount must be a valid integer" })
+  @IsOptional()
+  amount?: number;
+
+  @ApiProperty({
+    description: "The source of the biller item",
+    example: "Utility Bill",
+    required: false,
+  })
+  @IsString({ message: "Source must be a valid string" })
+  @IsOptional()
+  source?: string;
+
+  @ApiProperty({
+    description: "The customer identifier name for the biller item",
+    example: "Customer ID",
+    required: false,
+  })
+  @IsString({ message: "Customer identifier name must be a valid string" })
+  @IsOptional()
+  customerIdentifierName?: string;
+
+  @ApiProperty({
+    description: "The service fee associated with the biller item",
+    example: 10,
+    required: false,
+  })
+  @IsInt({ message: "Service fee must be a valid integer" })
+  @IsOptional()
+  serviceFee?: number;
+
+  @ApiProperty({
+    description: "The currency of the biller item",
+    example: "NGN",
+    required: false,
+  })
+  @IsString({ message: "Currency must be a valid string" })
+  @Length(1, 4, { message: "Currency must be between 1 and 4 characters" })
+  @IsOptional()
+  currency?: string;
+
+  @ApiProperty({
+    description: "The description of the biller item",
+    example: "Electricity Bill Payment",
+    required: false,
+  })
+  @IsString({ message: "Description must be a valid string" })
+  @IsOptional()
+  description?: string;
+
+  @ApiProperty({
+    description: "Indicates if the biller item is external",
+    example: false,
+    required: false,
+  })
+  @IsBoolean({ message: "External must be a valid boolean" })
+  @IsOptional()
+  external?: boolean;
+}
+
+export class CreateInvoiceDto {
+  @ApiProperty({
+    description: "The ID of the biller",
+    example: "550e8400-e29b-41d4-a716-446655440000",
+  })
+  @IsNotEmpty({ message: "Biller ID must not be empty" })
+  @IsString({ message: "Biller ID must be a valid string" })
+  billerId: string;
+
+  @ApiProperty({
+    description: "The ID of the customer",
+    example: "550e8400-e29b-41d4-a716-446655440001",
+  })
+  @IsNotEmpty({ message: "Customer ID must not be empty" })
+  @IsString({ message: "Customer ID must be a valid string" })
+  customerId: string;
+
+  @ApiProperty({
+    description: "The discount value applied to the invoice",
+    example: 10.5,
+  })
+  @IsNotEmpty({ message: "Discount value must not be empty" })
+  @IsInt({ message: "Discount value must be a valid number" })
+  discountValue: number;
+
+  @ApiProperty({
+    description: "The type of discount applied to the invoice",
+    example: "FIXED",
+  })
+  @IsNotEmpty({ message: "Discount type must not be empty" })
+  @IsEnum(["FIXED", "PERCENT"], { message: "Discount type must be FIXED or PERCENT" })
+  discountType: string;
+
+  @ApiProperty({
+    description: "The due date for the invoice",
+    example: "2025-01-31T23:59:59Z",
+  })
+  @IsNotEmpty({ message: "Due date must not be empty" })
+  @IsDateString({}, { message: "Due date must be a valid ISO 8601 date string" })
+  dueDate: string;
+
+  @ApiProperty({
+    description: "The status of the invoice",
+    example: "PENDING",
+  })
+  @IsNotEmpty({ message: "Status must not be empty" })
+  @IsEnum(["PENDING", "PAID", "CANCELLED"], { message: "Status must be PENDING, PAID, or CANCELLED" })
+  status: string;
+}
+
+export class UpdateInvoiceDto {
+  @ApiProperty({
+    description: "The ID of the invoice",
+    example: "550e8400-e29b-41d4-a716-446655440000",
+  })
+  @IsNotEmpty({ message: "ID must not be empty" })
+  @IsString({ message: "ID must be a valid string" })
+  id: string;
+
+  @ApiProperty({
+    description: "The ID of the biller",
+    example: "550e8400-e29b-41d4-a716-446655440000",
+    required: false,
+  })
+  @IsString({ message: "Biller ID must be a valid string" })
+  @IsOptional()
+  billerId?: string;
+
+  @ApiProperty({
+    description: "The ID of the customer",
+    example: "550e8400-e29b-41d4-a716-446655440001",
+    required: false,
+  })
+  @IsString({ message: "Customer ID must be a valid string" })
+  @IsOptional()
+  customerId?: string;
+
+  @ApiProperty({
+    description: "The discount value applied to the invoice",
+    example: 10.5,
+    required: false,
+  })
+  @IsInt({ message: "Discount value must be a valid number" })
+  @IsOptional()
+  discountValue?: number;
+
+  @ApiProperty({
+    description: "The type of discount applied to the invoice",
+    example: "FIXED",
+    required: false,
+  })
+  @IsEnum(["FIXED", "PERCENT"], { message: "Discount type must be FIXED or PERCENT" })
+  @IsOptional()
+  discountType?: string;
+
+  @ApiProperty({
+    description: "The due date for the invoice",
+    example: "2025-01-31T23:59:59Z",
+    required: false,
+  })
+  @IsDateString({}, { message: "Due date must be a valid ISO 8601 date string" })
+  @IsOptional()
+  dueDate?: string;
+
+  @ApiProperty({
+    description: "The status of the invoice",
+    example: "PENDING",
+    required: false,
+  })
+  @IsEnum(["PENDING", "PAID", "CANCELLED"], { message: "Status must be PENDING, PAID, or CANCELLED" })
+  @IsOptional()
+  status?: string;
+}