Genex

Interact with Genex API

Actions18

Overview

The Genex node's "Service" resource with the "Update Service Address" operation allows you to update the address details associated with a specific service for a customer in the Genex system. This is useful in scenarios where a customer's service location changes, such as moving premises or correcting address information. For example, a telecommunications provider might use this node to update the installation address of an internet service when a customer relocates.

Properties

Name Meaning
Customer Number Must be a valid Genex customer number. Identifies the customer whose service address is being updated.
Service Number Genex service number (from the Service Details section). The service must exist and not be released.
Address Type Name or ID Select from available address types or specify an ID using an expression. Determines the type of address being updated (e.g., physical, postal).
Address Type Number Numeric identifier for the address type. Optional additional specification.
Address Type Suffix Additional suffix for the address type, if applicable.
Property Name Name of the property (e.g., building name or unit).
Street Number Start Starting street number for the address. Useful for address ranges.
Street Number End Ending street number for the address, if applicable.
Street Number Suffix Suffix for the street number (e.g., A, B, etc.).
Street Name Name of the street.
Street Type Name or ID Select from available street types or specify an ID using an expression (e.g., Road, Avenue).
Street Type Suffix Name or ID Select from available street type suffixes or specify an ID using an expression (e.g., North, South).
Suburb Name of the suburb or locality.
State Name or ID Select from available states or specify an ID using an expression.
Postcode Postal code for the address.

Output

  • The output will be a JSON object reflecting the result of the address update operation.
  • The structure typically includes status information, any returned data from the Genex API, and may include error messages if the update fails.
  • No binary data is produced by this operation.

Example output (structure may vary depending on API response):

{
  "status": "success",
  "message": "Service address updated successfully.",
  "serviceNumber": "123456",
  "updatedFields": {
    "StreetName": "Main St",
    "Suburb": "Springfield"
  }
}

If there is an error, the output may look like:

{
  "error": "Invalid customer number",
  "details": "Customer number 99999 does not exist."
}

Dependencies

  • External Service: Requires access to the Genex API.
  • Credentials: You must configure genexApi credentials in n8n for authentication.
  • n8n Configuration: No special environment variables are required beyond standard credential setup.

Troubleshooting

  • Common Issues:

    • Invalid Customer or Service Number: Ensure both numbers exist and are correct in Genex.
    • Missing Required Fields: All required fields (such as Customer Number and Service Number) must be provided.
    • API Connectivity Problems: Network issues or incorrect credentials can prevent successful updates.

  • Error Messages:

    • "Invalid customer number": Check that the Customer Number exists in Genex.
    • "Service must exist in Genex and should not be released": Verify the Service Number is active and assigned to the customer.
    • "Authentication failed": Confirm your Genex API credentials are correctly configured in n8n.

Links and References

Discussion