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 allows users to create a new role within a company's configuration in the Sage Intacct system via the AvantGuard API. It is useful for automating role management, such as defining permissions, assigning roles to users or groups, and specifying role metadata programmatically. Practical scenarios include onboarding new employees with predefined access rights, updating role permissions in bulk, or integrating role creation into broader company setup workflows.
Properties
| Name | Meaning |
|---|---|
| Id | The unique identifier for the role being created (e.g., "Employee"). |
| Additional Body Fields | Optional additional fields to customize the role creation request: |
| - Key | Role key identifier (string). |
| - Href | URL reference for the role (string). |
| - Description | Text description of the role's purpose or scope. |
| - Role Type | Specifies the type of role; options are: Enterprise, E Console, Multi Entity Distributed, Multi Entity Shared. |
| - Apply To | Defines how the role applies to users based on access method; options are Login And Slide In, Login Only, Slide In Only. |
| - Role Permission Assignments | JSON array describing permission assignments for the role, including keys, IDs, modules, names, access rights, and audit info. |
| - Role Users | JSON array mapping roles assigned to specific users, including audit information. |
| - Role Groups | JSON array mapping roles assigned to user groups, including audit information. |
| - Audit | JSON object containing audit metadata such as creation and modification timestamps and user IDs. |
Output
The node outputs JSON data representing the newly created role object as returned by the API. This includes all properties sent in the request plus any additional metadata or identifiers generated by the backend. The output does not explicitly mention binary data, so it is assumed to be purely JSON structured.
Dependencies
- Requires an API key credential for authenticating with the AvantGuard Sage Intacct Company Configuration API.
- The base URL for the API must be configured in the credentials.
- The node uses HTTP headers to specify JSON content type and accept JSON responses.
Troubleshooting
Common issues:
- Missing required "Id" property will cause the API call to fail.
- Malformed JSON in any of the JSON-type fields (Role Permission Assignments, Role Users, Role Groups, Audit) can cause parsing errors.
- Incorrect or missing API credentials will result in authentication failures.
- Invalid values for enumerated fields like Role Type or Apply To may cause validation errors from the API.
Error messages and resolutions:
- 400 Bad Request: Check that all required fields are provided and JSON fields are correctly formatted.
- 401 Unauthorized: Verify that the API key credential is valid and has proper permissions.
- 422 Unprocessable Entity: Confirm that enumerated option values match allowed values exactly.
- Network or timeout errors: Ensure network connectivity and correct API endpoint configuration.
Links and References
- AvantGuard Sage Intacct API Documentation
- n8n HTTP Request Node Documentation
- JSON formatting guide for n8n nodes: https://docs.n8n.io/nodes/expressions/#json-fields