Account5

accountingData1

appRegistration3

Attributes10

Authentication2

BillOfMaterialsComponentsCommand2

BillOfMaterialsComponentsQuery2

BillsOfMaterialsCommand1

BillsOfMaterialsQuery1

BinLocationManagementCommand8

BinLocationManagementQuery3

cancellationreason5

Categories2

CategoryCommand3

CategoryQuery1

Channel5

Charges1

Clients2

colorcodes1

company1

CompanydetailsQuery1

Configuration7

CopyItemdetailsCommand1

CountryQuery1

CreateCommand5

creditnote3

customer28

customerCategory5

CustomerDomainCommand2

CustomerDomainQuery1

customerGroup5

deliverynote9

DuplicateItemCommand1

Events4

Extensibility6

features1

info1

invoice9

InvoicingCommand6

item5

ItemdetailsCommand7

ItemdetailsQuery1

LanguagesCommand2

LanguagesQuery1

login1

logout1

LotSizesQuery1

Meta11

Notification1

offer3

Offer12

OffersCommand5

onholdreason1

Order17

OrdersCommand9

paymentmethod1

printer1

ProductGroupsCommand3

ProductionItemsQuery2

ProductionOrdersCommand2

ProductionOrdersQuery1

property12

Report5

Reservations2

return5

Return2

returnreason1

returnstate1

saleschannel1

SalesChannelsCommand1

SalesInvoiceCorrectionDomainCommand2

SalesInvoiceDomainCommand2

salesorder33

SalesOrderDomainCommand4

SalesOrderDomainQuery3

SalesQuotationDomainCommand3

SalesQuotationDomainQuery1

Seller5

shipment2

ShipmentPackagesCommand2

ShipmentPackagesQuery1

ShippingClassCommand1

shippingmethod1

stock4

supplier1

Supported Prices1

tax2

TaxDomainCommand6

TaxDomainQuery1

Ticket6

transactionStatus1

Vouchers10

warehouse4

WarehouseAssistantCommand4

WarehouseZoneCommand5

wms4

WorkbenchResourcesCommand1

WorkbenchResourcesQuery1

WorkbenchResourceTypesCommand1

WorkbenchResourceTypesQuery1

worker4

Configuration

Get Number Ranges

Returns all available Number Ranges

get/v2/configuration/numberRanges

Request

Base URL
https://scx-sbx.api.jtl-software.com
Auth
- OAuth 2
  Authorization codehttps://auth.jtl-cloud.com/oauth2/auth
  Token URLhttps://auth.jtl-cloud.com/oauth2/token
  Scopessystem.config.read
- or OAuth 2
  Client credentials
  Token URLhttps://auth.jtl-cloud.com/oauth2/token
  Scopessystem.config.read
TypeScript
https://skmtc.dev/jtl-software/apis/scx-authentication-api/docs/v2/configuration/numberRanges/get.ts
A function with typed inputs. Its response is checked against the schema.

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.

Response

The available Number Ranges

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"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.