Patch update Charge Group

patch/charge-groups/{charge_group_id}
SecuritybearerAuth
Request
path Parameters
charge_group_id
required
integer <int64> (IdParam) >= 1

Charge group identifier

Example: 1
Request Body schema: application/json-patch+json

A set of JSONPatch operations to be performed

Array
op
required
string

The JSON Patch operation to be performed

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string

A JSON-Pointer

value
object

The value to be used within the operations

from
string

A string containing a JSON Pointer value

Responses
200

Success

400

Invalid Request

401

Unauthorized

403

Forbidden

404

Not Found

Request samples
application/json-patch+json
[
  • {
    • "op": "replace",
    • "path": "/name",
    • "value": "My Group"
    }
]
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
}