Create a new Charge Group

post/charge-groups
SecuritybearerAuth
Request
Request Body schema: application/json

New Charge Group

name
required
string [ 1 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Charge group name

chargeGroupCategoryId
required
integer <int64>

Identifier of category that this charge group belongs to

type
string (ChargeGroupType)

Type of charge group i.e. NATIONAL, LOCAL or GENERAL

Enum: "NATIONAL" "LOCAL" "GENERAL"
startDate
required
string <date>

Date this charge group applies from

endDate
string <date>

Date this charge group applies to

requiresAccessCharge
boolean
Default: false

Indicates that this charge group has an access charge

dontShowOnItemisation
boolean
Default: false

Indicator to control charges from this charge group showing on itemisation or not

applicableForDrcVat
boolean
Default: false

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

applyUsageCap
boolean
Default: false

Indicator to control whether a usage cap should be applied or not

taxBandId
integer <int64>

Identifier of tax band to apply for this charge group

Responses
200

OK

201

Created

400

Bad Request

401

Unauthorized

404

Not Found

412

Precondition Failed

500

Internal Server Error

501

Not Implemented Yet

Request samples
application/json
{
  • "name": "string",
  • "chargeGroupCategoryId": 1,
  • "type": "NATIONAL",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "requiresAccessCharge": false,
  • "dontShowOnItemisation": false,
  • "applicableForDrcVat": false,
  • "applyUsageCap": false,
  • "taxBandId": 1
}
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
}