Genex

Interact with Genex API

Overview

The Genex node's "Service" resource with the "Disconnect Service With Disconnection Reason" operation allows you to disconnect a specific service for a customer in the Genex system, specifying the reason and date for disconnection. This is useful for automating service management workflows, such as handling customer cancellations, scheduled disconnections, or enforcing business rules around service lifecycle events.

Practical examples:

  • Automatically disconnecting a customer's internet or phone service on a specified date due to non-payment or at their request.
  • Recording the reason for disconnection for compliance or reporting purposes.
  • Triggering downstream processes (e.g., notifying provisioning systems) when a service is disconnected.

Properties

Name Meaning
Customer Number Must be a valid Genex customer number. Identifies the customer whose service will be disconnected.
Service Number Genex service number associated with the customer. The service must exist in Genex and should not be released.
Disconnection Date The date from which the service should be disconnected. Can be set to a past or future date.
Send Disconnection Request Whether Genex should send a disconnection request in the provisioning file. Set to true to trigger provisioning actions, or false to only record the disconnection internally.
Disconnection Reason Name or ID Choose a disconnection reason from a list or specify an ID using an expression. The options are dynamically loaded from Genex.

Output

  • The node outputs a JSON object containing the result of the disconnection operation. The exact structure depends on the Genex API response, but typically includes:
    • Confirmation of the disconnection action
    • Details about the affected service and customer
    • Any error messages or status codes if the operation failed

Example output (structure may vary):

{
  "status": "success",
  "customerNumber": 12345,
  "serviceNumber": "SVC001234",
  "disconnectionDate": "2024-07-01T00:00:00Z",
  "disconnectionReason": "Customer Request",
  "provisioningTriggered": true
}

If the node encounters an error and "Continue On Fail" is enabled, the output will include an error field with details about the failure.

Dependencies

  • External Service: Requires access to the Genex API.
  • Credentials: You must configure n8n with valid Genex API credentials (genexApi).
  • Environment: No special environment variables are required beyond standard n8n credential setup.

Troubleshooting

Common issues:

  • Invalid Customer or Service Number: If the provided numbers do not exist or are already released, the operation will fail.
  • Missing Required Fields: All properties are required; omitting any will result in an error.
  • Disconnection Reason Not Found: If an invalid reason is specified, the API may reject the request.
  • API Connectivity Issues: Network problems or incorrect credentials will prevent successful execution.

Error messages:

  • "Must be a valid Genex customer number": Check that the customer exists in Genex.
  • "Service must exist in Genex and should not be released": Verify the service number and its status.
  • "Disconnection reason not found": Ensure the reason is selected from the available options or the correct ID is used.
  • "Authentication failed": Confirm your Genex API credentials are correct in n8n.

Links and References

Discussion