Customer Group

Manage customer groups in VARIO Cloud via the API, including creation, updates, activation, deactivation and deletion.

the CustomerGroup API

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstring · max: 255Required

Bezeichnung

descriptionstring · max: 255Optional

Beschreibung der Kundengruppe

activebooleanOptional

Aktiv

Default: true

404

Resource with given ID was not found

application/json

get/erp/account-types/customer-group/{id}

GET /erp/account-types/customer-group/{id} HTTP/1.1
Host: api.example.com
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "description": "text",
  "active": true
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstring · max: 255Required

Bezeichnung

descriptionstring · max: 255Optional

Beschreibung der Kundengruppe

activebooleanOptional

Aktiv

Default: true

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstring · max: 255Required

Bezeichnung

descriptionstring · max: 255Optional

Beschreibung der Kundengruppe

activebooleanOptional

Aktiv

Default: true

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put/erp/account-types/customer-group/{id}

PUT /erp/account-types/customer-group/{id} HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "description": "text",
  "active": true
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "description": "text",
  "active": true
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

contextstringOptional

message context

messageValuestringOptional

message

404

Resource was not found

application/json

409

unable to delete Resource, due to constraints, existing references or internal state

application/json

delete/erp/account-types/customer-group/{id}

DELETE /erp/account-types/customer-group/{id} HTTP/1.1
Host: api.example.com
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

deaktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstring · max: 255Required

Bezeichnung

descriptionstring · max: 255Optional

Beschreibung der Kundengruppe

activebooleanOptional

Aktiv

Default: true

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put/erp/account-types/customer-group/{id}/deactivate

PUT /erp/account-types/customer-group/{id}/deactivate HTTP/1.1
Host: api.example.com
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "description": "text",
  "active": true
}

aktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstring · max: 255Required

Bezeichnung

descriptionstring · max: 255Optional

Beschreibung der Kundengruppe

activebooleanOptional

Aktiv

Default: true

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put/erp/account-types/customer-group/{id}/activate

PUT /erp/account-types/customer-group/{id}/activate HTTP/1.1
Host: api.example.com
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "description": "text",
  "active": true
}

Create new Resource

post

Body

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstring · max: 255Required

Bezeichnung

descriptionstring · max: 255Optional

Beschreibung der Kundengruppe

activebooleanOptional

Aktiv

Default: true

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

labelstring · max: 255Required

Bezeichnung

descriptionstring · max: 255Optional

Beschreibung der Kundengruppe

activebooleanOptional

Aktiv

Default: true

422

Resource was not valid to process

application/json

post/erp/account-types/customer-group

POST /erp/account-types/customer-group HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "version": "text",
  "info": {},
  "id": "text",
  "label": "text",
  "description": "text",
  "active": true
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "label": "text",
  "description": "text",
  "active": true
}