Rest Accounting

Interact with Rest Accounting API
Join our community

Actions13

Overview

This node integrates with the Rest Accounting API to retrieve various accounting data and perform operations related to accounts, journal entries, and financial reports. Specifically, for the Reports resource with the Profit & Loss operation, it fetches a Profit & Loss report from the accounting system.

This node is useful in scenarios where you want to automate financial reporting workflows, such as generating periodic profit and loss statements for analysis, auditing, or integration into other business intelligence tools. For example, a user can schedule this node to run monthly to pull the latest Profit & Loss report and then send it via email or store it in a database.

Properties

Name Meaning
Query Parameters A collection of optional filters and pagination settings to customize the report request. Includes:
• Start Date: Filter report data from this date (string).
• End Date: Filter report data up to this date (string).
• Page: Page number for paginated results (number, default 1).
• Page Size: Number of items per page (number, default 50).

Note: The "Reference" and "Description" query parameters are defined but only applicable to the Journals resource's search operation, so they do not apply here.

Output

The node outputs an array with one item containing a json property. This JSON object holds the Profit & Loss report data as returned by the Rest Accounting API. The exact structure depends on the API response but typically includes financial figures such as revenues, expenses, net profit, and possibly breakdowns by categories or periods.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Rest Accounting API.
  • The node expects the base URL of the Rest Accounting API and the API key to be configured in the credentials.
  • No additional environment variables or external services are required beyond the API access.

Troubleshooting

  • Common Issues:

    • Invalid or missing API key will cause authentication failures.
    • Incorrect date formats in query parameters may lead to API errors or empty results.
    • Pagination parameters that exceed available pages might return empty datasets.

  • Error Messages:

    • "Request failed": Generic error indicating the HTTP request to the API did not succeed. Check network connectivity, API endpoint correctness, and credentials.
    • Errors wrapped in NodeApiError include the original message from the API; review these messages for specific issues like invalid parameters or permission problems.

  • Resolution Tips:

    • Verify API key validity and permissions.
    • Ensure date strings follow the expected format (usually ISO 8601).
    • Adjust pagination parameters within valid ranges.
    • Review API documentation for any changes in endpoint behavior.

Links and References

Discussion