# List PremInvoicePayment Extended

Lists PremInvoicePayment Extended objects which include invoice posted payments and payment applied fields.

Endpoint: GET /premium-invoice-payments-ext/{invoiceKey}
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

  - `vbasoftware-database` (string, required)
    Target database

## Path parameters:

  - `invoiceKey` (integer, required)
    Invoice Key

## Query parameters:

  - `invoiceYear` (integer)
    Invoice Year

  - `page` (integer)
    Page

  - `pageSize` (integer)
    Page Size

  - `sortBy` (string)
    Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

## Response 200 fields (text/plain):

  - `data` (array,null)

  - `data.invoiceKey` (integer)
    Invoice the payment is for

  - `data.premPaymentKey` (integer)
    Payment that is applied to the invoice

  - `data.paymentId` (string,null)
    ID for the Payment

  - `data.paymentAmount` (number)
    Amount of the Payment

  - `data.paymentDate` (string,null)
    Date of the Payment

  - `data.invoicePostedPayments` (number)

  - `data.paymentPosted` (number)
    Payment posted to the invoice

  - `data.paymentPostedDate` (string,null)
    Date the Payment was Posted to the invoice

  - `data.paymentApplied` (number)
    Calculated field that sums the PremInvoiceReceived, PremInvoiceSelfAdminReceived and PremInvoiceAdjReceived.

  - `data.entryUser` (string,null)
    User that first added the record to the system

  - `data.entryDate` (string)
    Date record was first added to the system

  - `data.updateUser` (string,null)
    User that last updated the record in the system

  - `data.updateDate` (string)
    Date the record was last updated in the system

  - `error` (object)

  - `error.detail` (string,null)
    A human-readable explanation specific to this occurrence of the problem.

  - `error.instance` (string,null)
    A URI reference that identifies the specific occurrence of the problem.It may
or may not yield further information if dereferenced.

  - `error.status` (integer)
    The HTTP status code([RFC7231], Section 6) generated by the origin server for
this occurrence of the problem.

  - `error.title` (string,null)
    A short, human-readable summary of the problem type.It SHOULD NOT change from
occurrence to occurrence of the problem, except for purposes of localization(e.g.,
using proactive content negotiation; see[RFC7231], Section 3.4).

  - `error.type` (string,null)
    A URI reference [RFC3986] that identifies the problem type. This specification
encourages that, when dereferenced, it provide human-readable documentation for
the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member
is not present, its value is assumed to be "about:blank".

  - `debug` (object)

  - `debug.activityID` (string, required)


## Response 401 fields