@openmrs/esm-billing-app 1.1.2-pre.8 → 1.2.0

package/src/billing.resource.test.ts

@@ -1,23 +1,17 @@
+import { describe, expect, it, vi } from 'vitest';
 import { mapBillProperties } from './billing.resource';
+import { calculateTotalAmount } from './helpers/functions';
 import type { LineItem, PatientInvoice, Payment } from './types';
 
 type CashPoint = PatientInvoice['cashPoint'];
 type Provider = PatientInvoice['cashier'];
 type Patient = PatientInvoice['patient'];
 
-const mockFormatDate = jest.fn((date: Date, options?: Partial<{ mode: string }>) => `formatted-${date}`);
-const mockParseDate = jest.fn((dateString: string): Date => new Date(dateString));
-
-jest.mock('@openmrs/esm-framework', () => ({
-  formatDate: (date: Date, options?: Partial<{ mode: string }>) => mockFormatDate(date, options),
-  parseDate: (dateString: string) => mockParseDate(dateString),
-}));
-
 const createLineItem = (overrides: Partial<LineItem> = {}): LineItem => ({
   uuid: 'line-item-uuid',
   item: 'Service Item',
   billableService: 'Billable Service',
-  paymentStatus: 'PENDING',
+  status: 'PENDING',
   quantity: 1,
   price: 100,
   priceName: 'Standard',
@@ -74,26 +68,34 @@ const createPayment = (overrides: Partial<Payment> = {}): Payment => ({
   ...overrides,
 });
 
-const createBaseBill = (overrides: Partial<PatientInvoice> = {}): PatientInvoice => ({
-  uuid: 'uuid1',
-  display: '12345 - John Doe',
-  voided: false,
-  voidReason: null,
-  adjustedBy: [],
-  billAdjusted: null,
-  cashPoint: createCashPoint(),
-  cashier: createProvider(),
-  dateCreated: '2024-01-01T00:00:00Z',
-  lineItems: [],
-  patient: createPatient(),
-  payments: [],
-  receiptNumber: 'R123',
-  status: 'PENDING',
-  adjustmentReason: null,
-  id: 1,
-  resourceVersion: '1.0',
-  ...overrides,
-});
+const createBaseBill = (overrides: Partial<PatientInvoice> = {}): PatientInvoice => {
+  const lineItems = overrides.lineItems ?? [];
+  const serverTotal = calculateTotalAmount(lineItems);
+  return {
+    uuid: 'uuid1',
+    display: '12345 - John Doe',
+    voided: false,
+    voidReason: null,
+    adjustedBy: [],
+    billAdjusted: null,
+    cashPoint: createCashPoint(),
+    cashier: createProvider(),
+    dateCreated: '2024-01-01T00:00:00Z',
+    lineItems,
+    patient: createPatient(),
+    payments: [],
+    receiptNumber: 'R123',
+    status: 'PENDING',
+    adjustmentReason: null,
+    id: 1,
+    resourceVersion: '1.0',
+    total: serverTotal,
+    amountAfterDiscount: serverTotal,
+    discounts: [],
+    refunds: [],
+    ...overrides,
+  };
+};
 
 describe('mapBillProperties', () => {
   describe('Amount calculations', () => {
@@ -345,8 +347,8 @@ describe('mapBillProperties', () => {
     it('Handles partial payment correctly', () => {
       const bill = createBaseBill({
         lineItems: [
-          createLineItem({ price: 100, quantity: 1, paymentStatus: 'PAID' }),
-          createLineItem({ price: 50, quantity: 1, paymentStatus: 'PENDING' }),
+          createLineItem({ price: 100, quantity: 1, status: 'PAID' }),
+          createLineItem({ price: 50, quantity: 1, status: 'PENDING' }),
         ],
         payments: [createPayment({ amountTendered: 100 })],
       });
@@ -359,7 +361,7 @@ describe('mapBillProperties', () => {
     it('Handles overpayment (change due scenario)', () => {
       const bill = createBaseBill({
         status: 'PAID',
-        lineItems: [createLineItem({ price: 100, quantity: 1, paymentStatus: 'PAID' })],
+        lineItems: [createLineItem({ price: 100, quantity: 1, status: 'PAID' })],
         payments: [createPayment({ amount: 100, amountTendered: 150 })],
       });
       const result = mapBillProperties(bill);
@@ -371,11 +373,11 @@ describe('mapBillProperties', () => {
     it('Handles complex bill with mixed item states', () => {
       const bill = createBaseBill({
         lineItems: [
-          createLineItem({ paymentStatus: 'PAID', voided: false, price: 100, quantity: 1, item: 'Consultation' }),
-          createLineItem({ paymentStatus: 'PENDING', voided: false, price: 50, quantity: 2, item: 'Lab Test' }),
-          createLineItem({ paymentStatus: 'PAID', voided: true, price: 200, quantity: 1, item: 'Canceled X-Ray' }),
+          createLineItem({ status: 'PAID', voided: false, price: 100, quantity: 1, item: 'Consultation' }),
+          createLineItem({ status: 'PENDING', voided: false, price: 50, quantity: 2, item: 'Lab Test' }),
+          createLineItem({ status: 'PAID', voided: true, price: 200, quantity: 1, item: 'Canceled X-Ray' }),
           createLineItem({
-            paymentStatus: 'PAID',
+            status: 'PAID',
             voided: false,
             price: 25,
             quantity: 3,
@@ -398,8 +400,8 @@ describe('mapBillProperties', () => {
       const bill = createBaseBill({
         status: 'PAID',
         lineItems: [
-          createLineItem({ paymentStatus: 'PENDING', voided: true }),
-          createLineItem({ paymentStatus: 'PENDING', voided: true }),
+          createLineItem({ status: 'PENDING', voided: true }),
+          createLineItem({ status: 'PENDING', voided: true }),
         ],
       });
       const result = mapBillProperties(bill);
@@ -411,7 +413,7 @@ describe('mapBillProperties', () => {
 
     it('Handles bill with no payments yet', () => {
       const bill = createBaseBill({
-        lineItems: [createLineItem({ price: 100, quantity: 1, paymentStatus: 'PENDING' })],
+        lineItems: [createLineItem({ price: 100, quantity: 1, status: 'PENDING' })],
         payments: [],
       });
       const result = mapBillProperties(bill);
@@ -424,8 +426,8 @@ describe('mapBillProperties', () => {
       const bill = createBaseBill({
         status: 'PAID',
         lineItems: [
-          createLineItem({ price: 50, quantity: 3, paymentStatus: 'PAID' }), // Originally 1, adjusted to 3
-          createLineItem({ price: 100, quantity: 0, paymentStatus: 'PAID' }), // Adjusted to 0
+          createLineItem({ price: 50, quantity: 3, status: 'PAID' }), // Originally 1, adjusted to 3
+          createLineItem({ price: 100, quantity: 0, status: 'PAID' }), // Adjusted to 0
         ],
         payments: [createPayment({ amountTendered: 150 })],
       });

package/src/billing.resource.ts

@@ -1,4 +1,4 @@
-import useSWR from 'swr';
+import useSWR, { type KeyedMutator } from 'swr';
 import sortBy from 'lodash-es/sortBy';
 import {
   openmrsFetch,
@@ -17,6 +17,7 @@ import {
   type CreateBillPayload,
   type UpdateBillPayload,
   BillStatus,
+  type PatientPaymentStatus,
 } from './types';
 
 const parsePatientDisplay = (display: string | undefined): { identifier: string; name: string } => {
@@ -46,15 +47,15 @@ export const mapBillProperties = (bill: PatientInvoice): MappedBill => {
     patientName: name,
     identifier: identifier,
     patientUuid: bill?.patient?.uuid,
+    visitUuid: bill?.visit?.uuid,
     cashPointUuid: bill?.cashPoint?.uuid,
     cashPointName: bill?.cashPoint?.name,
     cashPointLocation: bill?.cashPoint?.location?.display,
     status: bill.status as BillStatus,
     lineItems: activeLineItems,
     billingService: activeLineItems.map((lineItem) => lineItem?.item || lineItem?.billableService || '--').join('  '),
-    totalAmount: activeLineItems
-      .map((item) => (item.price ?? 0) * (item.quantity ?? 0))
-      .reduce((prev, curr) => prev + curr, 0),
+    totalAmount: bill.total,
+    netAmount: bill.amountAfterDiscount,
     tenderedAmount: (bill?.payments ?? [])
       .map((item) => item.amountTendered ?? 0)
       .reduce((prev, curr) => prev + curr, 0),
@@ -93,8 +94,7 @@ export const usePaginatedBills = (pageSize: number, status?: string, patientName
   };
 };
 
-export const useBills = (patientUuid?: string, billStatus?: string) => {
-  // Build URL with status parameter if provided
+export const useBills = (patientUuid?: string, billStatus?: string, visitUuid?: string) => {
   let url = `${apiBasePath}bill?v=full`;
 
   if (patientUuid) {
@@ -105,6 +105,10 @@ export const useBills = (patientUuid?: string, billStatus?: string) => {
     url += `&status=${billStatus}`;
   }
 
+  if (visitUuid) {
+    url += `&visitUuid=${visitUuid}`;
+  }
+
   const { data, error, isLoading, isValidating, mutate } = useOpenmrsFetchAll<PatientInvoice>(url);
 
   const sortedBills = sortBy(data ?? [], ['dateCreated']).reverse();
@@ -119,23 +123,42 @@ export const useBills = (patientUuid?: string, billStatus?: string) => {
   };
 };
 
-export const useBill = (billUuid: string) => {
+export function useBill(
+  billUuid: string,
+  mapProperties: false,
+): {
+  bill: PatientInvoice | null;
+  error: any;
+  isLoading: boolean;
+  isValidating: boolean;
+  mutate: KeyedMutator<{ data: PatientInvoice }>;
+};
+
+export function useBill(
+  billUuid: string,
+  mapProperties?: true,
+): {
+  bill: MappedBill | null;
+  error: any;
+  isLoading: boolean;
+  isValidating: boolean;
+  mutate: KeyedMutator<{ data: PatientInvoice }>;
+};
+
+export function useBill(billUuid: string, mapProperties = true) {
   const url = `${apiBasePath}bill/${billUuid}`;
   const { data, error, isLoading, isValidating, mutate } = useSWR<{ data: PatientInvoice }>(
     billUuid ? url : null,
     openmrsFetch,
   );
 
-  const formattedBill = data?.data ? mapBillProperties(data?.data) : null;
+  let bill: MappedBill | PatientInvoice | null = null;
+  if (data?.data) {
+    bill = mapProperties ? mapBillProperties(data.data) : data.data;
+  }
 
-  return {
-    bill: formattedBill,
-    error,
-    isLoading,
-    isValidating,
-    mutate,
-  };
-};
+  return { bill, error, isLoading, isValidating, mutate };
+}
 
 export const processBillPayment = (payload: PaymentRequestPayload, billUuid: string) => {
   const url = `${apiBasePath}bill/${billUuid}/payment`;
@@ -212,3 +235,29 @@ export const deleteBillItem = (itemUuid: string, voidReason: string) => {
     method: 'DELETE',
   });
 };
+
+export const deleteBill = (billUuid: string, reason: string) => {
+  const url = `${apiBasePath}bill/${billUuid}?reason=${encodeURIComponent(reason)}`;
+
+  return openmrsFetch(url, {
+    method: 'DELETE',
+  });
+};
+
+export const patientPaymentStatusCacheKey = (patientUuid: string) =>
+  `${apiBasePath}patientPaymentStatus/${patientUuid}`;
+
+export const usePatientPaymentStatus = (patientUuid: string) => {
+  const url = patientPaymentStatusCacheKey(patientUuid);
+  const { data, error, isLoading, isValidating, mutate } = useSWR<{ data: PatientPaymentStatus }>(
+    patientUuid ? url : null,
+    openmrsFetch,
+  );
+  return {
+    paymentStatus: data?.data,
+    error,
+    isLoading,
+    isValidating,
+    mutate,
+  };
+};

package/src/bills-table/bills-table.component.tsx

@@ -45,7 +45,7 @@ interface BillDisplayItem extends Omit<MappedBill, 'id'> {
 interface BillPaymentStatusFilterItem {
   id: BillStatus | '';
   text: string;
-  status: BillStatus | '';
+  status: string;
 }
 
 const mapLineItems = (bill: MappedBill) =>
@@ -72,13 +72,24 @@ const BillsTable: React.FC = () => {
       },
       { id: BillStatus.POSTED, text: t('pendingPaymentBills', 'Pending payment'), status: BillStatus.POSTED },
       { id: BillStatus.PAID, text: t('paidBills', 'Paid bills'), status: BillStatus.PAID },
+      {
+        id: BillStatus.REFUNDED,
+        text: t('refundedBills', 'Refunded bills'),
+        status: `${BillStatus.REFUNDED},${BillStatus.PARTIALLY_REFUNDED}`,
+      },
+      {
+        id: BillStatus.REFUND_REQUESTED,
+        text: t('pendingRefundBills', 'Pending refunds'),
+        status: BillStatus.REFUND_REQUESTED,
+      },
     ],
     [t],
   );
 
-  // Default to 'POSTED' (pending payment) so cashiers see bills awaiting payment on load
+  // Default to 'PENDING' (pending confirmation) so cashiers see bills awaiting confirmation on load
   const [billPaymentStatus, setBillPaymentStatus] = useState<BillPaymentStatusFilterItem>(
-    () => billPaymentStatusFilterItems.find((item) => item.id === BillStatus.POSTED) ?? billPaymentStatusFilterItems[0],
+    () =>
+      billPaymentStatusFilterItems.find((item) => item.id === BillStatus.PENDING) ?? billPaymentStatusFilterItems[0],
   );
   const [searchString, setSearchString] = useState('');
   const debouncedSearchString = useDebounce(searchString, 500);
@@ -173,7 +184,7 @@ const BillsTable: React.FC = () => {
       </div>
 
       {isLoading && !bills?.length ? (
-        <div className={styles.loaderContainer} role="progressbar" aria-label={t('loading', 'Loading')}>
+        <div className={styles.loaderContainer} data-testid="bills-table-skeleton">
           <DataTableSkeleton
             rowCount={pageSize}
             showHeader={false}