Skip to main content
GET
/
v1
/
configuration
/
numberRanges
/
{numberRangeId}
/
preview
Number Range Preview
curl --request GET \
  --url https://api.jtl-cloud.com/erp/v1/configuration/numberRanges/{numberRangeId}/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>'
{
  "NextNumber": "<string>",
  "IsPreview": true
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
x-api-key
string
header
required

Optional: If no token is present, the API Gateway injects it.

Headers

​
x-appid
string
required

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

​
x-appversion
string
required

This is where the version number of your application is entered, e.g. "1.0.0".

​
x-runas
string

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

​
X-SessionId
string<uuid>

The id of a session in which the call will be executed.

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

​
numberRangeId
string<uuid>
required

The id of the NumberRange Schlüssel für einen Nummernkreis Datensatz

Query Parameters

​
companyId
integer<int32>

Gets the unique identifier for the firm. Represents a key for identifying a firm within the application.

Response

The resulting Next Number for the given Item.

The CurrentValue of Individuel NumberRange

​
NextNumber
string
required

The Next Number of the NumberRange

​
IsPreview
boolean
required

Can the Number is only a Preview Number