Genex

Interact with Genex API

Actions18

Overview

The "Release Service" operation in the Genex n8n node allows users to release (disconnect) a specific service associated with a customer in the Genex system. This is typically used by telecom or utility providers who need to automate the process of releasing services for customers, such as when a customer cancels a subscription or requests disconnection of a particular service.

Practical examples:

  • Automating the disconnection of internet or phone services when a customer account is closed.
  • Scheduling future service releases based on contract end dates.
  • Integrating customer support workflows to trigger service release upon request.

Properties

Name Meaning
Customer Number Must be a valid Genex customer number. Identifies the customer whose service is being released.
Service Number Genex service number associated with the customer. The service must exist and should not already be released.
Release Date The date on which the service should 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. Options: true (send), false (do not send).

Output

The output will contain the result of the release service operation as returned by the Genex API. The structure typically includes:

  • Confirmation of the service release action.
  • Any status or reference IDs provided by Genex.
  • Error messages if the operation failed.

Example output structure:

{
  "status": "Success",
  "serviceNumber": "123456",
  "releaseDate": "2024-07-01T00:00:00Z",
  "disconnectionDate": "2024-07-02T00:00:00Z",
  "message": "Service released successfully"
}

Note: Actual fields may vary depending on the Genex API response.

Dependencies

  • External Service: Requires access to the Genex API.
  • API Credentials: You must configure genexApi credentials in n8n.
  • Environment: Ensure network access to the Genex API endpoint (https://genexapi.billing.com.au/).

Troubleshooting

Common issues:

  • Invalid Customer or Service Number: If the provided numbers do not exist or are incorrect, the API will return an error.
  • Service Already Released: Attempting to release a service that has already been released may result in an error message.
  • Missing Required Fields: All properties are required; missing any will cause the operation to fail.
  • Credential Errors: Incorrect or missing API credentials will prevent the node from connecting to Genex.

Error messages and resolutions:

  • "Customer not found": Verify the Customer Number is correct and exists in Genex.
  • "Service not found": Check the Service Number and ensure it is linked to the specified customer.
  • "Service already released": No further action needed unless this is unexpected; check service status before attempting release.
  • "Authentication failed": Update your Genex API credentials in n8n.

Links and References

Discussion