Actions43
- Earning Types Actions
- Email Templates Actions
- Employee Types Actions
- Employees Actions
- Entities Actions
- Classes Actions
- Contacts Actions
- Department Groups Actions
- Exchange Rate Lines Actions
- Exchange Rate Types Actions
- Exchange Rates Actions
- Attachment Folders Actions
- Get Next Value Actions
- Location Groups Actions
- Locations Actions
- Roles Actions
- User Groups Actions
- Users Actions
- Affiliate Entity Groups Actions
- Attachments Actions
- Departments Actions
- Document Sequences Actions
Overview
This node operation creates a new document sequence configuration within a company setup, specifically for the "Document Sequences" resource under the "Create Company Config Document Sequence" operation. Document sequences are used to generate unique identifiers for documents such as invoices, purchase orders, or other transactional records in a controlled and consistent manner.
Typical use cases include:
- Automating invoice numbering with customizable prefixes, suffixes, and numeric or alphanumeric sequences.
- Managing document numbering schemes that reset annually or by fiscal year.
- Ensuring compliance with company or regional standards for document identification.
For example, a user can create a sequence named "Vendors" that generates invoice numbers starting at 1, padded to a fixed length, with a prefix like "INV-", and automatically rolls over each fiscal year.
Properties
| Name | Meaning |
|---|---|
| Id | Unique name 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" (alphabetic). 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 are zero-padded; alpha sequences are padded with 'a's. |
| - Fixed Prefix | Characters appearing before the primary sequence (e.g., "INV"). |
| - Prefix Separator | Characters between the prefix and the auto-generated sequence (e.g., "-"). |
| - Fixed Suffix | Characters appearing after the primary 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 the sequence to restart automatically each fiscal year. Includes settings like enabling rollover, separator characters, and specific fiscal year configurations. |
| - Status | Object status: "Active" (fully functional) or "Inactive" (hidden and unusable). |
| - Href | URL endpoint of the document sequence object. |
| - Audit | JSON object containing audit information such as creation and modification timestamps and user IDs. |
Output
The node outputs JSON data representing the newly created document sequence object. This includes all properties sent in the request along with any system-generated fields such as unique keys or URLs.
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 to communicate with the API endpoint
/ia/api/v1.
Troubleshooting
- Authentication errors: Ensure the API key credential is valid and has appropriate permissions.
- Validation errors: Missing required fields like "Id" or invalid field formats (e.g., non-numeric values for numeric fields) will cause errors. Double-check property values.
- API connectivity issues: Verify network access to the configured base URL and that the API service is operational.
- Rollover configuration errors: Incorrect JSON structure in the rollover field may cause failures. Use valid JSON and ensure fiscal year entries are properly formatted.
Links and References
- AvantGuard Sage Intacct API Documentation
- n8n Documentation on Creating Custom Nodes
- General concepts on document sequencing and numbering best practices in accounting systems.