Steuerboard icon

Steuerboard

Consume the Steuerboard API

Overview

The node integrates with the Steuerboard API to manage various resources, including Admin Users. Specifically, the "Update" operation for the "Admin User" resource allows you to modify details of an existing accountant user in the system. This is useful in scenarios where user information such as name or role needs to be updated without creating a new user.

Practical examples include:

  • Changing the first or last name of an accountant user after a legal name change.
  • Updating the role of a user from a standard user to an admin or assigning a custom role ID.

Properties

Name Meaning
User ID The unique identifier of the accountant user to update (required).
Fields Collection of fields to update for the user:
  First Name The new first name of the accountant user.
  Last Name The new last name of the accountant user.
  Role Role to assign to the user. Can be 'admin', 'user', or a custom role ID.

Output

The node outputs JSON data representing the updated state of the Admin User after the update operation. This typically includes the user's ID, updated names, assigned role, and possibly other metadata returned by the Steuerboard API.

If the node supports binary data output (not indicated here), it would represent files or attachments related to the user, but this is not applicable for the Admin User update operation.

Dependencies

  • Requires an active connection to the Steuerboard API.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • The base URL for the API must be set in the credentials configuration.

Troubleshooting

  • Missing or invalid User ID: The update will fail if the User ID is not provided or incorrect. Ensure the User ID corresponds to an existing accountant user.
  • Invalid role value: Assigning a role outside 'admin', 'user', or a valid custom role ID may cause errors. Verify role values before updating.
  • API connectivity issues: Network problems or incorrect API base URL/credentials can prevent successful updates.
  • Empty fields collection: If no fields are specified to update, the request might be rejected or have no effect.

To resolve these:

  • Double-check input parameters for correctness.
  • Confirm API credentials and endpoint configurations.
  • Review error messages returned by the API for specific guidance.

Links and References

  • Steuerboard API documentation (refer to official Steuerboard API docs for detailed endpoints and payloads).
  • n8n documentation on creating and configuring API credential nodes.

Discussion