ConnectWise Manage icon

ConnectWise Manage

Consume ConnectWise Manage API

Overview

The node integrates with the ConnectWise Manage API to perform operations on various resources, including Purchase Orders. Specifically, for the Purchase Order - Search operation, it allows users to search and filter purchase orders based on a custom search query and order the results by specified fields.

This node is beneficial in scenarios where you need to automate retrieval of purchase order data from ConnectWise Manage, such as:

  • Fetching purchase orders matching specific criteria (e.g., vendor, status, date range) for reporting or further processing.
  • Integrating purchase order data into other systems or workflows.
  • Automating inventory or procurement processes by dynamically searching purchase orders.

Example use case: A user wants to retrieve all purchase orders containing a certain keyword or vendor name, ordered by their ID descending, to generate a report or trigger follow-up actions.

Properties

Name Meaning
Order By Field to order results by. Example: "ID desc" or simply "id".
Search Query The search query string used to filter purchase orders. This is required for the search operation.

Note: The "Order By" property appears twice in the provided properties but serves the same purpose — specifying the field and direction to sort the results.

Output

  • The output is an array of JSON objects representing purchase orders that match the search query.
  • Each item in the output corresponds to one purchase order returned by the API.
  • The structure of each JSON object matches the purchase order data schema from ConnectWise Manage, including fields like purchaseOrderId, vendorId, and other purchase order details.
  • No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the ConnectWise Manage API via an API key credential configured in n8n.
  • The node uses the ConnectWise Manage REST API v3.0 endpoints.
  • Proper API credentials and permissions are necessary to access purchase order data.
  • The node expects the base site URL for the ConnectWise Manage instance to be configured in the credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect or malformed search queries may result in empty results or API errors.
    • Using unsupported fields in the "Order By" parameter can lead to API errors.
    • Network connectivity issues between n8n and ConnectWise Manage API endpoint.
  • Error messages:

    • "Operation 'search' is not supported for resource 'purchaseOrder'": Indicates a misconfiguration or unsupported operation/resource combination.
    • "API request failed": Generic error indicating failure in making the API call; check credentials and network.
    • Errors related to missing required parameters (e.g., missing search query) will prompt validation errors before execution.
  • Resolution tips:

    • Verify API credentials and permissions.
    • Ensure the search query syntax matches ConnectWise Manage API expectations.
    • Use valid field names for ordering.
    • Check network connectivity and API availability.

Links and References

Discussion