# Get PremInvoice Group Summary

Gets PremInvoice Summary for the specified group id and invoice year.  First PremInvoiceSelfAdmin table is checked for the group id, if found the values are aggregated from come from PremInvoiceSelfAdmin; if the group is not found in PremInvoiceSelfAdmin, the PremInvoiceSubscriber table is checked for this group.  If not present in either table, an error is returned.

Endpoint: GET /premium-invoices-group-summary
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

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

## Query parameters:

  - `groupId` (string, required)
    Group ID

  - `invoiceYear` (integer, required)
    Invoice Year

## Response 200 fields (text/plain):

  - `data` (object)

  - `data.subscriberCount` (integer, required)

  - `data.paidSubscriberCount` (integer, required)

  - `data.dependentCount` (integer, required)

  - `data.paidDependentCount` (integer, required)

  - `data.memberCount` (integer, required)

  - `data.paidMemberCount` (integer, required)

  - `data.premium` (number, required)

  - `data.premiumReceived` (number, required)

  - `data.postedPayment` (number, required)

  - `data.unpostedAmount` (number, required)

  - `data.amountDue` (number, required)

  - `data.headerAdjustment` (number, required)

  - `data.subscriberAdjustment` (number, required)

  - `data.adjustmentReceived` (number, required)

  - `data.detailAdjustment` (number, required)

  - `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