Genex

Interact with Genex API

Actions18

Overview

The "Update Service Extra Information" operation for the "Service" resource in this custom n8n node allows users to update the "Extra Information" field of a specific service associated with a customer in the Genex system. This is useful in scenarios where additional metadata or notes need to be attached to a service record, such as tracking special instructions, internal references, or other custom data.

Practical examples:

  • Adding a note about a customer's service upgrade.
  • Storing a reference code or ticket number related to a service.
  • Updating internal comments for support or billing teams.

Properties

Name Meaning
Customer Number Must be a valid Genex customer number. Identifies the customer whose service will be updated.
Service Number Genex service number (from the Service Details section). The service must exist and not be released.
Extra Information Value to be updated into the Extra Information field for the specified service.

Output

The output structure is not explicitly detailed in the provided code, but based on standard n8n conventions and the SOAP call pattern, the node will return the response from the Genex API after updating the extra information. Typically, this would include:

{
  "success": true,
  "message": "Extra Information updated successfully",
  "serviceNumber": "string",
  "customerNumber": number,
  // ...any additional fields returned by the Genex API
}

If an error occurs and "Continue On Fail" is enabled, the output may also include an error field with details about the failure.

Dependencies

  • External Service: Requires access to the Genex API (https://genexapi.billing.com.au/).
  • API Credentials: You must configure valid Genex API credentials in n8n under the name genexApi.
  • SOAP Dependency: Uses the soap npm package to communicate with the Genex API.

Troubleshooting

Common Issues:

  • Invalid Customer or Service Number: If the provided numbers do not match existing records, the API will likely return an error.
  • Missing Required Fields: All three properties are required; omitting any will result in a validation error.
  • Authentication Errors: Incorrect or missing API credentials will prevent successful communication with the Genex API.
  • Service Released: Attempting to update a service that has been released will fail.

Error Messages:

  • "Must be a valid Genex customer number": Ensure the customer number exists in Genex.
  • "Service must exist in Genex and should not be released": Double-check the service number and its status.
  • SOAP/network errors: Check network connectivity and Genex API availability.

Links and References

Discussion