> ## Documentation Index
> Fetch the complete documentation index at: https://developer.jtl-software.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NumberRange

> The rule by which the system builds the numbers of one type: text in front of the counter, the counter, and text behind it. A range without a company is the global range that every company without a range of its own uses; a range with a company applies to the documents of that company only.



**Kind**: `object`

## Fields

**`id`**: `ID!`

The ID of the number range.

---

**`typeKey`**: `String!`

The key of the number range type in upper case (UPPER_SNAKE_CASE), see 'QueryNumberRangeTypes'. It cannot change. A client that meets a key it does not know shows it as it is.

---

**`companyId`**: `ID`

The company the range is for. Empty for the global range of the type. It cannot change.

---

**`prefix`**: `String!`

The text in front of the counter, empty if none. Prefix and suffix may contain the date tokens '<J>' (year, four digits), '<M>' (month, two digits), '<T>' (day, two digits) and '<K>' (ISO calendar week, two digits). The tokens are upper case; the system replaces them with the date of issue when it issues a number. Lower case tokens are not replaced and are rejected.

---

**`suffix`**: `String!`

The text behind the counter, empty if none.

---

**`nextCounter`**: `Int!`

The counter the next number is built from. It is the number that is tried next, not the last one issued: if a document already has the resulting number, the system takes the next higher counter until a free number is found. The counter is written without leading zeros.

---

**`maxNumberLength`**: `Int`

The most characters an issued number may have: the length of the field that stores the number, but at most 50. Empty if the length cannot be determined.

---

**`isDeletable`**: `Boolean!`

Whether the range can be deleted. Only the range of a company can, the global range of a type cannot; see 'GetNumberRangeAllowedActions'.