Actions43
- Location Groups Actions
- Locations Actions
- Roles Actions
- User Groups Actions
- Users Actions
- Affiliate Entity Groups Actions
- Attachments Actions
- Classes Actions
- Contacts Actions
- Department Groups Actions
- Departments Actions
- Document Sequences Actions
- Earning Types Actions
- Email Templates Actions
- Employee Types Actions
- Employees Actions
- Entities Actions
- Exchange Rate Lines Actions
- Exchange Rate Types Actions
- Exchange Rates Actions
- Attachment Folders Actions
- Get Next Value Actions
Overview
This node operation creates a new Document Sequence configuration within a company setup. Document sequences are used to generate unique identifiers for documents such as invoices, purchase orders, or other transactional records. This node is beneficial when automating the creation of standardized numbering or naming conventions for documents in financial or operational systems.
Practical examples include:
- Automatically generating invoice numbers with a fixed prefix and numeric sequence.
- Creating alpha-numeric sequences for cash management documents.
- Setting up fiscal year rollover configurations so that document numbering restarts each fiscal year.
Properties
| Name | Meaning |
|---|---|
| Id | Unique name identifier for the document sequence (e.g., "Vendors"). |
| Additional Body Fields | Optional additional configuration fields for the document sequence: |
| - Key | System-assigned unique key for the document sequence. |
| - Print Title | The sequence name that appears on printed invoice PDFs. |
| - Type | Sequence type: either "Numeric" (numbers) or "Alpha" (letters). Alpha sequences are mainly for Cash Management or French companies. |
| - Fixed Length | Total length of the primary sequence including padding (up to 16 characters). Numeric sequences pad with zeroes; alpha sequences pad with 'a's. |
| - Fixed Prefix | Characters appearing before the main sequence (e.g., "INV"). |
| - Prefix Separator | Characters between the prefix and the auto-generated sequence (e.g., "-"). |
| - Fixed Suffix | Characters appearing after the main sequence (e.g., "COMPANY"). |
| - Suffix Separator | Characters between the auto-generated sequence and the suffix (e.g., "-"). |
| - Starting Number | Starting number for numeric sequences (default 1). |
| - Ending Number | Ending number for numeric sequences (default 100). |
| - Next Number | The next number to be used in the sequence. |
| - Starting Sequence | Starting string for alpha sequences (default "a"). |
| - Ending Sequence | Ending string for alpha sequences (default "zzz"). |
| - Next Sequence | The next alpha sequence to be used. |
| - When Modified | Timestamp indicating when the document sequence was last modified. |
| - Entity | JSON object representing the entity (e.g., company region or department) where this document sequence applies. |
| - Rollover | Fiscal year rollover configuration allowing automatic restart of sequences each fiscal year. Includes settings like enabling rollover, separator characters, fiscal year details, and next number/sequence per year. |
| - Status | Object status: "Active" (fully functional) or "Inactive" (hidden and unusable). |
| - Href | URL endpoint of the document sequence resource. |
| - Audit | JSON object containing audit information such as creation and modification timestamps and user IDs. |
Output
The node outputs a JSON object representing the newly created document sequence configuration. This includes all properties sent in the request along with any system-generated fields such as unique keys or URLs. The output can be used downstream to confirm creation or to reference the document sequence in further automation steps.
No binary data output is involved.
Dependencies
- Requires an API key credential for authentication to the AvantGuard Sage Intacct Company Configuration API.
- The base URL for the API must be configured in the node credentials.
- The node uses JSON payloads and expects the API to accept and return JSON.
Troubleshooting
Common issues:
- Missing required property "Id" will cause the API call to fail.
- Invalid JSON format in complex fields like "Entity", "Rollover", or "Audit" may cause parsing errors.
- Providing incompatible values for sequence type and related fields (e.g., alpha sequences with numeric-only settings) may result in validation errors.
- Network or authentication failures if API credentials or base URL are misconfigured.
Error messages:
- "400 Bad Request": Usually indicates missing or invalid input properties. Verify required fields and JSON formats.
- "401 Unauthorized": Check API key credential validity and permissions.
- "422 Unprocessable Entity": Likely due to business logic validation errors such as sequence conflicts or invalid rollover configurations.
Resolving these typically involves verifying input data correctness, ensuring proper credential setup, and consulting API documentation for valid field values.
Links and References
- AvantGuard Sage Intacct API Documentation
- n8n Documentation on Custom Nodes
- General concepts on document sequencing and numbering best practices in accounting systems.