# Get a list of charge-groups

Endpoint: GET /charge-groups
Version: 1.12
Security: bearerAuth

## Query parameters:

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

  - `name` (string)
    Filter by name
    Example: "xyz | in:x,y | like:xyz"

  - `chargeGroupCategoryId` (string)
    Filter by a particular charge group category id
    Example: "0"

  - `startDate` (string)
    Filter charge groups based on start date
    Example: "yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd"

  - `endDate` (string)
    Filter charge groups based on end date
    Example: "yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd"

## Response 200 fields (application/json):

  - `id` (integer)
    Internal identifier of charge group
    Example: 1

  - `name` (string, required)
    Charge group name

  - `chargeGroupCategoryId` (integer, required)
    Identifier of category that this charge group belongs to
    Example: 1

  - `type` (string)
    Type of charge group i.e. NATIONAL, LOCAL or GENERAL
    Enum: "NATIONAL", "LOCAL", "GENERAL"

  - `startDate` (string, required)
    Date this charge group applies from

  - `endDate` (string)
    Date this charge group applies to

  - `requiresAccessCharge` (boolean)
    Indicates that this charge group has an access charge

  - `dontShowOnItemisation` (boolean)
    Indicator to control charges from this charge group showing on itemisation or not

  - `applicableForDrcVat` (boolean)
    Indicates that charges in this charge group are applicable for VAT DRC (Domestic Reverse Charge)

  - `applyUsageCap` (boolean)
    Indicator to control whether a usage cap should be applied or not

  - `taxBandId` (integer)
    Identifier of tax band to apply for this charge group
    Example: 1


## Response 400 fields

## Response 401 fields

## Response 404 fields

## Response 412 fields

## Response 500 fields

## Response 501 fields