Fatture in Cloud icon

Fatture in Cloud

Interact with Fatture in Cloud API

Overview

This node integrates with the "Fatture in Cloud" API to manage various business-related resources. Specifically, for the Archive Document resource with the List operation, it retrieves a paginated list of archived documents for a specified company. This is useful for scenarios where you need to access historical or stored documents such as invoices, receipts, or other financial records.

Practical examples include:

  • Fetching all archived documents for a company to generate reports.
  • Integrating archived document data into other workflows or systems.
  • Filtering and retrieving specific fields from archived documents for auditing or compliance purposes.

Properties

Name Meaning
Company ID The numeric identifier of the company whose archive documents you want to list.
Filter Options A collection of optional filters to refine the list results:
  Fields Comma-separated list of specific fields to include in the response (e.g., id,date,total).
  Fieldset Level of detail for the response; options are: Basic (minimal info) or Detailed (full details).
  Page Page number for pagination (default is 1).
  Per Page Number of results per page (default is 50).

Output

The node outputs an array of JSON objects representing archived documents matching the query parameters. Each object contains fields depending on the selected fieldset and requested fields, typically including document metadata such as IDs, dates, amounts, and statuses.

If binary data were involved (not indicated here), it would represent file contents or attachments related to the archive documents.

Dependencies

  • Requires an active connection to the Fatture in Cloud API using an OAuth2-based API key credential.
  • The node depends on the internal ArchiveModule class that handles API requests for archive documents.
  • Pagination and filtering rely on the API's support for these features.

Troubleshooting

  • Common issues:

    • Invalid or missing Company ID will cause the API to reject the request.
    • Requesting fields not supported by the API may result in errors or incomplete data.
    • Pagination parameters out of range might return empty results or errors.
    • Network or authentication failures can interrupt data retrieval.
  • Error messages:

    • Errors returned from the API are captured and presented with status codes and messages.
    • If the node is set to continue on failure, error details are included in the output JSON under an error property.
    • Typical error message format:
      Fatture in Cloud API Error: <error message>
      with additional details about HTTP status and response data.
  • Resolution tips:

    • Verify the Company ID is correct and accessible with your credentials.
    • Check the filter options for valid values.
    • Ensure your API credentials are up to date and have necessary permissions.
    • Use smaller page sizes if timeouts or large responses occur.

Links and References


This summary is based solely on static analysis of the provided source code and input property definitions. It does not execute or simulate runtime behavior.

Discussion