Get a list of charge-groups

get/charge-groups
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
name
string (StringFilterParam)

Filter by name

Example: name=xyz | in:x,y | like:xyz
chargeGroupCategoryId
string (IdFilterParam)

Filter by a particular charge group category id

Example: chargeGroupCategoryId=0
startDate
string (DateFilterParam)

Filter charge groups based on start date

Example: startDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
endDate
string (DateFilterParam)

Filter charge groups based on end date

Example: endDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

412

Precondition Failed

500

Internal Server Error

501

Not Implemented Yet

Response samples
application/json
[
  • {
    • "id": 1,
    • "name": "string",
    • "chargeGroupCategoryId": 1,
    • "type": "NATIONAL",
    • "startDate": "2019-08-24",
    • "endDate": "2019-08-24",
    • "requiresAccessCharge": false,
    • "dontShowOnItemisation": false,
    • "applicableForDrcVat": false,
    • "applyUsageCap": false,
    • "taxBandId": 1
    }
]