Sign in

v1

latestOpenAPI 3.0.22026-07-223907721.1 MB
Configuration

Create Number Range

Create a new NumberRange based on the given NumberRange

post/v2/configuration/numberRanges/{numberRangeId}

Path parameters

numberRangeIdstring uuid required

Schlüssel für einen Nummernkreis Datensatz

The id of the NumberRange on who this NumberRange is Based

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

x-companyidstring

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Request body

prefixstring

The Number Prefix for the NumberRange

currentNumberinteger

The Current Number of the NumberRange

suffixstring

The Number Suffix for the NumberRange

companyIdstring uuid

Represents a key for identifying a firm within the application.

Example request

{
  "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}

Response

The new Created NumberRange

identifierstring uuid

Schlüssel für einen Nummernkreis Datensatz

namestring

The Name of the Number Range

descriptionstring

The Name of the Number Range

prefixstring

The Number Prefix for the NumberRange

currentNumberinteger

The Current Number of the NumberRange

suffixstring

The Number Suffix for the NumberRange

maxLengthinteger

The Max Length of an Number Range

companyIdstring uuid

Represents a key for identifying a firm within the application.

exampleNumberstring

The Example of a Number

isDeletableboolean

Can the Number Range be deleted

Example response

{
  "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
}