documentNumbering

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

Returns the document numbering series for invoices, quotes, orders and the other document types: each one's prefix, separator, padding, date format, reset policy and next number. Requires permission to read tenant settings or to update document 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:

GraphQL

query DocumentNumbering {
  documentNumbering {
    fiscalYearStart
    localDate
    series {
      nextNumber
      dateFormat
      docType
      isCustomized
      lastIssued
      padWidth
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query DocumentNumbering {\n  documentNumbering {\n    fiscalYearStart\n    localDate\n    series {\n      nextNumber\n      dateFormat\n      docType\n      isCustomized\n      lastIssued\n      padWidth\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "documentNumbering": {
      "fiscalYearStart": "string",
      "localDate": "string",
      "series": [
        {
          "nextNumber": 0,
          "dateFormat": "string",
          "docType": "COLLECTION",
          "isCustomized": true,
          "lastIssued": "string",
          "padWidth": 0
        }
      ]
    }
  }
}

documentNumbering: DocumentNumberingSettings!

Type

DocumentNumberingSettings object

The number series of every document type.