# Get a list of invoice payment events

Endpoint: GET /invoice-payment-events
Version: 1.21
Security: bearerAuth

## Query parameters:

  - `customerId` (integer)
    Customer identifier
    Example: 1

  - `invoiceId` (integer)
    Invoice identifier
    Example: 1

  - `billRunType` (string)
    Bill Run Type
    Enum: "NORMAL", "ADHOC"

  - `page` (integer, required)
    Page of results to show
    Example: 1

  - `pageSize` (integer, required)
    Results to return per page
    Example: 100

  - `sort` (string)
    Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change
    Example: "id,name | name:desc"

  - `fields` (string)
    Comma-delimited list of the field(s) to return if only a subset is required
    Example: "id,name"

## Response 200 fields (application/json):

  - `id` (integer)
    Invoice History identifier
    Example: 1

  - `invoiceId` (integer, required)
    Invoice identifier

  - `customerId` (integer)
    Customer identifier
    Example: 1

  - `billRunType` (string, required)
    Billing run type
    Enum: "NORMAL", "ADHOC"

  - `paymentStatus` (string, required)
    Invoice payment status
    Enum: "NA", "PAID", "UNPAID", "PENDING", "REFUNDED", "PART_REFUNDED", "REFUND_PENDING", "WRITTEN_OFF", "DISPUTED", "PARTIALLY_PAID"

  - `notes` (string, required)
    Notes on payment change

  - `amountInMajorCurrency` (number)
    Amount in major currency (e.g pounds/dollars/euros)
    Example: 10.5


## Response 400 fields

## Response 401 fields

## Response 403 fields