bigcapital/packages/server/src/interfaces/BillPayment.ts

import { Knex } from 'knex';
import { IBill } from './Bill';

export interface IBillPaymentEntry {
  id?: number;
  billPaymentId: number;
  billId: number;
  paymentAmount: number;

  bill?: IBill;
}

export interface IBillPayment {
  id?: number;
  vendorId: number;
  amount: number;
  currencyCode: string;
  reference: string;
  paymentAccountId: number;
  paymentNumber: string;
  paymentDate: Date;
  exchangeRate: number | null;
  userId: number;
  entries: IBillPaymentEntry[];
  statement: string;
  createdAt: Date;
  updatedAt: Date;

  localAmount?: number;
  branchId?: number;
}

export interface IBillPaymentEntryDTO {
  billId: number;
  paymentAmount: number;
}

export interface IBillPaymentDTO {
  vendorId: number;
  paymentAccountId: number;
  paymentNumber?: string;
  paymentDate: Date;
  exchangeRate?: number;
  statement: string;
  reference: string;
  entries: IBillPaymentEntryDTO[];
  branchId?: number;
}

export interface IBillReceivePageEntry {
  billId: number;
  entryType: string;
  billNo: string;
  dueAmount: number;
  amount: number;
  totalPaymentAmount: number;
  paymentAmount: number;
  currencyCode: string;
  date: Date | string;
}

export interface IBillPaymentsService {
  validateVendorHasNoPayments(tenantId: number, vendorId): Promise<void>;
}

export interface IBillPaymentEventCreatedPayload {
  tenantId: number;
  billPayment: IBillPayment;
  billPaymentId: number;
  trx: Knex.Transaction;
}

export interface IBillPaymentCreatingPayload {
  tenantId: number;
  billPaymentDTO: IBillPaymentDTO;
  trx: Knex.Transaction;
}

export interface IBillPaymentEditingPayload {
  tenantId: number;
  billPaymentDTO: IBillPaymentDTO;
  oldBillPayment: IBillPayment;
  trx: Knex.Transaction;
}
export interface IBillPaymentEventEditedPayload {
  tenantId: number;
  billPaymentId: number;
  billPayment: IBillPayment;
  oldBillPayment: IBillPayment;
  trx: Knex.Transaction;
}

export interface IBillPaymentEventDeletedPayload {
  tenantId: number;
  billPaymentId: number;
  oldBillPayment: IBillPayment;
  trx: Knex.Transaction;
}

export interface IBillPaymentDeletingPayload {
  tenantId: number;
  oldBillPayment: IBillPayment;
  trx: Knex.Transaction;
}

export interface IBillPaymentPublishingPayload {
  tenantId: number;
  oldBillPayment: IBillPayment;
  trx: Knex.Transaction;
}

export enum IPaymentMadeAction {
  Create = 'Create',
  Edit = 'Edit',
  Delete = 'Delete',
  View = 'View',
}