Document Numbering Mutations

UpdateDocumentSequenceConfigs

Updates document numbering configurations for one or more document types.

Parameters:

Parameter	Type	Description
input	[DocumentSequenceConfigInput!]!	List of configurations to update.

Example Query:

GraphQL

mutation UpdateDocumentSequenceConfigs($input: [DocumentSequenceConfigInput!]!) {
  UpdateDocumentSequenceConfigs(input: $input) {
    id
    document_type
    format_mode
    manual_override_allowed
    prefix
    next_number
    padding_length
    reset_policy
    shared_sequence_with
    can_apply_now
  }
}

Example Variables:

JSON

{
  "input": [
    {
      "document_type": "invoice",
      "format_mode": "auto",
      "prefix": "INV-",
      "next_number": 1001,
      "padding_length": 5
    }
  ]
}

Return Type	Description
[DocumentSequenceConfig]	Updated configurations.

---

Input Data Types

DocumentSequenceConfigInput

Field	Type	Description
document_type	String!	Document type (e.g., invoice, estimate, order).
format_mode	String	Numbering mode: auto (system-generated) or manual (user-defined).
manual_override_allowed	Boolean	Allow users to manually override the number.
prefix	String	Prefix before the number (e.g., INV-).
next_number	Int	Next number in sequence.
padding_length	Int	Zero-padding length (e.g., 5 → 00001).
reset_policy	String	When to reset the sequence: never, yearly, monthly.
apply_timing	String	When to apply the number: on_creation or on_finalization.
shared_sequence_with	String	Share sequence with another document type.

---

Data Types

DocumentSequenceConfig

Field	Type	Description
id	Int!	Unique identifier.
company_id	Int!	Company ID.
document_type	String!	Document type.
format_mode	String!	Numbering mode.
manual_override_allowed	Boolean!	Manual override allowed.
prefix	String	Number prefix.
next_number	Int	Next number in sequence.
padding_length	Int	Zero-padding length.
reset_policy	String	Reset policy.
current_period_key	String	Current period key for reset tracking.
shared_sequence_with	String	Shared sequence document type.
can_apply_now	Boolean!	Whether settings can be applied immediately.
pending_settings	JSON	Pending configuration changes.
pending_activation_period_key	String	Period key for pending activation.