AvantGuard - Sage Intacct (Company Configuration) icon

AvantGuard - Sage Intacct (Company Configuration)

AvantGuard - Sage Intacct (Company Configuration)

Actions43

Overview

This node enables creating a new Department Group within a company's configuration in Sage Intacct. Department Groups are used to organize departments logically, which can be helpful for reporting and financial analysis. By grouping departments, users can generate reports that summarize or break down data by these groups, improving clarity and management of departmental data.

Common scenarios include:

  • Setting up department groups for sales, marketing, or production teams.
  • Creating dimension structures from department groups to use as rows or columns in financial reports.
  • Defining specific or dynamic membership of departments within a group based on filters or explicit members.

Example: A company wants to create a "Sales" department group with ID "SA01" that includes specific departments like "Retail Sales" and "Online Sales" to analyze sales performance collectively.

Properties

Name Meaning
Id Department group ID. Displayed together with the group name in Sage Intacct (ID--Name). This ID is immutable once the group is created.
Name Department group name. Displayed together with the group ID in Sage Intacct (ID--Name).
Additional Body Fields Optional additional fields to customize the department group:
- Key System-assigned unique key for the department group.
- Href URL endpoint for the department group.
- Description Description of the department group.
- Group Type Group membership type determining how departments are included:
specific — Specify exact departments and their order.
all — Include all departments matching the member filter criteria.
- Member Filter JSON object defining filter criteria when groupType is all. Filters specify conditions (e.g., status active, totalDue > 1000) to dynamically include departments.
- Group Members JSON array listing members of the department group and their sort order. Only applicable when groupType is specific.
- Is Dimension Structure Boolean indicating if the group should be treated as a dimension structure usable in financial report rows or columns.
- 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 Department Group object as returned by the Sage Intacct API. This typically includes all properties sent in the request along with system-generated metadata such as keys, URLs, and audit details.

If binary data were involved (not indicated here), it would represent file attachments or similar content, but this node focuses solely on JSON data.

Dependencies

  • Requires an API key credential for authenticating with the Sage Intacct Company Configuration API.
  • The base URL for the API must be configured in the node credentials.
  • Uses the AvantGuard Sage Intacct Company Configuration API endpoint /ia/api/v1.

Troubleshooting

  • Invalid or missing required fields: Ensure that both Id and Name are provided and valid. Missing these will cause the API to reject the request.
  • Immutable ID error: Attempting to change an existing department group's ID after creation will fail; IDs cannot be modified.
  • Incorrect JSON format: For fields like memberFilter, groupMembers, and audit, ensure valid JSON syntax. Parsing errors will prevent successful requests.
  • Authentication failures: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Group Type mismatch: When groupType is specific, groupMembers must be provided; when all, memberFilter should be used. Providing inconsistent data may cause errors.

Links and References

Discussion