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 "Create Company Config Location" under the "Locations" resource allows users to create a new location entry in a company configuration system, typically used for financial or operational management. It is useful for organizations that need to manage multiple physical or logical locations with detailed metadata such as identifiers, contact information, status, and hierarchical relationships.
Practical examples include:
- Adding a new office location with its unique ID, name, and contact details.
- Defining operational dates and tax IDs for compliance and reporting.
- Setting up location hierarchies by specifying parent locations.
- Assigning managers and audit information to track changes.
This node is beneficial in automating the creation of location records in integrated accounting or ERP systems, ensuring consistent data entry and reducing manual errors.
Properties
| Name | Meaning |
|---|---|
| Id | Unique identifier for the location. |
| Name | Name of the location. |
| Additional Body Fields | Optional additional fields to enrich the location data: |
| - Key | System-assigned unique key for the location, used in URLs or JSON bodies for operations on the location. |
| - Href | URL endpoint for this location. |
| - Status | Status of the location, indicating if it is active, active non-posting (usable in reports but not transactions), or inactive. Options: active, activeNonPosting, inactive. |
| - Tax Id | State tax ID or VAT registration number. |
| - Start Date | Start date of operation at this location (format: YYYY-MM-DD). |
| - End Date | End date of operation at this location (format: YYYY-MM-DD). |
| - Contacts | JSON object listing contacts related to the location, including primary and shipping contacts with detailed personal and address information. |
| - Location Reporting Title | A descriptive title for reports, supplementing the location name, e.g., including address or manager name. |
| - Parent | JSON object defining the parent location for hierarchical structuring, including key, id, href, and name. |
| - Manager | JSON object representing the employee managing the location, including key, id, href, and name. |
| - Audit | JSON object containing audit information such as creation and modification timestamps and user identifiers. |
Output
The node outputs JSON data representing the newly created location object as returned by the API. This JSON includes all the properties sent in the request along with any additional metadata or identifiers assigned by the backend system.
If the node supports binary data output, it would typically relate to attachments or documents linked to the location, but based on the provided code and properties, this node focuses solely on JSON data.
Dependencies
- Requires an API key credential for authentication to the target company configuration system.
- The base URL for the API must be configured in the node credentials.
- Uses JSON format for sending and receiving data.
- Depends on the external service's REST API endpoint
/ia/api/v1for creating location objects.
Troubleshooting
- Missing Required Fields: Errors may occur if mandatory fields like
IdorNameare not provided. Ensure these are set before execution. - Invalid JSON in Complex Fields: Fields like
contacts,parent,manager, andauditexpect valid JSON strings. Malformed JSON will cause parsing errors. - API Authentication Failures: If the API key or base URL is incorrect or missing, the node will fail to authenticate. Verify credentials and endpoint configuration.
- Status Field Validation: Providing an invalid status value outside the allowed options (
active,activeNonPosting,inactive) may result in API rejection. - Date Format Issues: Dates should follow the
YYYY-MM-DDformat; otherwise, the API might reject the request.
Links and References
- JSON Data Types
- REST API Design Best Practices
- Common Date Formats
- Documentation for the specific company configuration API (not provided here) would be essential for deeper integration details.