ConnectWise Manage icon

ConnectWise Manage

Consume ConnectWise Manage API

Actions102

Overview

The node integrates with the ConnectWise Manage API to perform various operations on different resources, including invoices. Specifically, for the Invoice - Search operation, it allows users to search and filter invoices based on a custom search query. This is useful in scenarios where you want to retrieve invoices matching specific criteria, such as invoices related to a particular company, date range, status, or other invoice attributes.

Practical examples include:

  • Searching for all unpaid invoices for a given client.
  • Filtering invoices created within a certain time frame.
  • Retrieving invoices sorted by invoice ID or date.

This operation supports pagination and ordering of results, enabling efficient handling of large datasets.

Properties

Name Meaning
Search Query A required string that defines the search conditions to filter invoices (e.g., "status='Open'").
Order By Field to order the search results by, e.g., "id desc" or "dateCreated asc". Defaults to "id".

Output

The output is an array of JSON objects, each representing an invoice matching the search criteria. Each object contains the invoice data fields as returned by the ConnectWise Manage API under the finance/invoices endpoint.

  • The output does not include binary data.
  • Pagination is handled internally; if "Return All" is enabled, multiple pages of results are fetched and combined.
  • If limited, only the specified number of invoices is returned.

Example output structure (simplified):

[
  {
    "invoiceId": 123,
    "company": {...},
    "amount": 1000,
    "status": "Open",
    "dateCreated": "2023-01-01T00:00:00Z",
    ...
  },
  ...
]

Dependencies

  • Requires an active connection to the ConnectWise Manage API.
  • Needs an API authentication credential configured in n8n (an API key or token).
  • The node uses the base URL from the credential configuration to construct API requests.

Troubleshooting

  • Error: Operation 'search' is not supported
    This occurs if the resource or operation parameters are incorrect or unsupported. Ensure the resource is set to "Invoice" and operation to "Search".

  • API request failed / ConnectWise Error Response Body
    Indicates issues with the API call, such as invalid credentials, malformed search queries, or network problems. Verify API credentials and the correctness of the search query syntax.

  • Missing or invalid parameters
    The "Search Query" property is required. Omitting it will cause errors.

  • Pagination limits
    If too many results are requested without enabling "Return All," the node may return fewer results than expected. Enable "Return All" to fetch all matching invoices.

Links and References

Discussion