Skip to main content
inputCreateNumberRangeCommandRequestInput

Fields

typeKey
String!
required

The key of the number range type, see 'QueryNumberRangeTypes', for example 'SALES_INVOICE'. Any case is accepted; responses carry the key in upper case.

companyId
ID!
required

The company the range is for. An inactive company is allowed. It cannot change later.

prefix
String!
required

The text in front of the counter, empty if none, at most 20 characters. Prefix and suffix may contain the date tokens '' (year, four digits), '' (month, two digits), '' (day, two digits) and '' (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!
required

The text behind the counter, empty if none, at most 20 characters.

nextCounter
Int!
required

The counter the first number is built from, 0 to 2147483646.

idempotencyKey
String

Client-supplied idempotency key. When provided, a repeated request with the same key and payload replays the original result instead of re-executing the mutation.