Skip to main content

updateDocumentNumberSeries

Requires at least one of the permissions settings:documents:update or settings:tenant:update.

Changes one document number series: its prefix, separator, padding, date format, reset policy or next number. The change waits for any number being issued, so no document is numbered halfway through, and it is audited. Requires permission to update document settings or tenant settings.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

mutation UpdateDocumentNumberSeries($input: UpdateDocumentNumberSeriesInput!) {
  updateDocumentNumberSeries(input: $input) {
    nextNumber
    dateFormat
    docType
    isCustomized
    lastIssued
    padWidth
  }
}

Variables:

{
  "input": {
    "docType": "COLLECTION"
  }
}

Response:

{
  "data": {
    "updateDocumentNumberSeries": {
      "nextNumber": 0,
      "dateFormat": "string",
      "docType": "COLLECTION",
      "isCustomized": true,
      "lastIssued": "string",
      "padWidth": 0
    }
  }
}
updateDocumentNumberSeries(
  input: UpdateDocumentNumberSeriesInput!
): DocumentNumberSeries!

Arguments​

updateDocumentNumberSeries.input ● UpdateDocumentNumberSeriesInput! non-null input​

The document type and the series fields to change.

Type​

DocumentNumberSeries object​

The number series of one document type, as Settings shows it.