Document Numbering Queries

Query document numbering sequences and formats.

`DocumentNumberingContext`

Returns the effective numbering context for a document type, including whether manual override is allowed, shared sequences, and date constraints.

Parameters:

Parameter	Type	Description
`document_type`	String!	Document type (e.g., `invoice`, `estimate`).
`dated_at`	String	Date for context (format: `YYYY-MM-DD`).

Example Query:

query GetDocumentNumberingContext($document_type: String!, $dated_at: String) {
  DocumentNumberingContext(document_type: $document_type, dated_at: $dated_at) {
    manual_override_allowed_effective
    shared_sequence_with
    preview
    min_date
    max_date
  }
}

Example Variables:

{
  "document_type": "invoice",
  "dated_at": "2026-01-15"
}

Field	Type	Description
`manual_override_allowed_effective`	Boolean!	Whether manual number override is currently allowed.
`shared_sequence_with`	String	Document type sharing the same sequence, if any.
`preview`	String!	Preview of the next document number.
`min_date`	String	Minimum allowed date for this document type.
`max_date`	String	Maximum allowed date for this document type.

`DocumentSequencePreview`

Returns a preview of the next document number for a given document type and date.

Parameters:

Parameter	Type	Description
`document_type`	String!	Document type (e.g., `invoice`, `estimate`).
`dated_at`	String	Date for the preview (format: `YYYY-MM-DD`).

Example Query:

query GetDocumentSequencePreview($document_type: String!, $dated_at: String) {
  DocumentSequencePreview(document_type: $document_type, dated_at: $dated_at)
}

Example Variables:

{
  "document_type": "invoice",
  "dated_at": "2026-01-15"
}

Return Type	Description
`String!`	Preview of the next document number.

`DocumentFinalizationDateConstraints`

Returns the minimum and maximum allowed dates for finalizing a document of a given type.

Parameters:

Parameter	Type	Description
`document_type`	String!	Document type (e.g., `invoice`, `estimate`).

Example Query:

query GetDocumentFinalizationDateConstraints($document_type: String!) {
  DocumentFinalizationDateConstraints(document_type: $document_type) {
    min_date
    max_date
  }
}

Example Variables:

{
  "document_type": "invoice"
}

Field	Type	Description
`min_date`	String	Minimum allowed finalization date.
`max_date`	String	Maximum allowed finalization date.