Interface IPaymentService

Interface for Payment Service that extends IAppRemoteService with IPayment type.

Hierarchy

Implemented by

Properties

db: Dexie
moduleName: string

Methods

  • Adds a payment to an invoice.

    Parameters

    • invoice: IInvoice

      The invoice to add the payment to.

    • amount: number

      The amount of the payment.

    • paymentMethod: IPaymentMethod

      The payment method used for the payment.

    Returns Promise<IInvoice>

    A promise that resolves to the updated invoice.

  • Retrieves multiple entities with optional pagination and filtering.

    Parameters

    • params: any

      [UNUSED PARAMETER, KEPT FOR POSSIBLE FUTURE USE] Filtering parameters.

    • options: {
          page?: number;
          pageSize?: number;
      }

      Query options including pagination.

      • Optional page?: number
      • Optional pageSize?: number

    Returns Promise<{
        count: number;
        list: IPayment[];
        page: number;
        pageSize: number;
    }>

    An object containing the retrieved entities and total count.

  • Removes a payment from an invoice.

    Parameters

    • invoice: IInvoice

      The invoice to remove the payment from.

    • payment_uid: string

      The unique identifier of the payment to remove.

    Returns Promise<IInvoice>

    A promise that resolves to the updated invoice.

Generated using TypeDoc