Nuvem Solution icon

Nuvem Solution

Interact with Nuvem Solution API

Actions120

Cliente → Get Clientes Geral

AI-generated

Overview

The "Get Clientes Geral" operation of the "Cliente" resource in this node allows users to retrieve a general list of customers from the Nuvem Solution API. It supports pagination and optional date range filtering, enabling efficient querying of customer data over specific periods.

This node is beneficial in scenarios where you need to:

  • Fetch a paginated list of customers for reporting or analysis.
  • Retrieve customers created or updated within a certain date range.
  • Integrate customer data into other workflows or systems.

For example, a business might use this node to regularly sync their customer database with an external CRM or to generate reports on customer activity within a given timeframe.

Properties

Name Meaning
Page The page number to retrieve in the paginated results (default is 1).
Page Size The number of customer items to return per page (default is 20).
Start At Optional start date/time filter to include only customers from this date onwards.
End At Optional end date/time filter to include only customers up to this date.

Output

The output is a JSON array containing customer records as returned by the Nuvem Solution API endpoint /erp/crm/clientes/listarClientesGeral. Each item in the array represents a customer with its associated data fields as provided by the API.

The structure typically includes customer details such as IDs, names, contact information, and other relevant metadata. The exact fields depend on the API response schema.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Nuvem Solution API.
  • The node uses bearer token authentication obtained via the configured credentials.
  • The base URL for the API and authentication tokens are managed internally.
  • Proper configuration of the API credentials (software key, secret, user ID, user key) is necessary for successful requests.

Troubleshooting

  • Authentication failures: If the node throws errors related to authentication, verify that the API credentials are correct and have not expired.
  • Invalid date filters: Ensure that the Start At and End At dates are in valid ISO 8601 format and that Start At is before End At.
  • Pagination issues: Requesting pages beyond the available range may result in empty responses; adjust the Page and Page Size accordingly.
  • API errors: Any unexpected API errors will be surfaced as node errors. Check the error message for details and consult the API documentation or support.

Links and References

If you need further details about other operations or resources, feel free to ask!

Discussion