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 reports. Specifically, for the Reports - Balance Sheet operation, it fetches a balance sheet report from the accounting system. This is useful for financial analysis, auditing, or generating periodic financial statements.

Typical use cases include:

  • Automatically retrieving up-to-date balance sheet reports for financial review.
  • Integrating balance sheet data into dashboards or other reporting tools.
  • Scheduling regular exports of balance sheets for compliance or bookkeeping.

Properties

Name Meaning
Query Parameters A collection of optional filters and pagination settings to customize the report query:
- Start Date The start date for the report period (string).
- End Date The end date for the report period (string).
- Page The page number for paginated results (number, default 1).
- Page Size The number of items per page in paginated results (number, default 50).

Note: Although the property definition includes some fields like "Reference" and "Description," these are only applicable to journal searches and not relevant for the Balance Sheet report.

Output

The node outputs JSON data representing the balance sheet report retrieved from the API. The structure typically includes financial account balances grouped by categories such as assets, liabilities, and equity, reflecting the organization's financial position at the specified dates.

No binary data output is produced by this operation.

Example output JSON structure (simplified):

{
  "assets": [...],
  "liabilities": [...],
  "equity": [...],
  "reportDate": "2025-01-31",
  "totalAssets": 100000,
  "totalLiabilitiesAndEquity": 100000
}

Dependencies

  • Requires an API key credential for authenticating with the Rest Accounting API.
  • The node uses HTTP requests to communicate with the API endpoint defined by the base URL in the credentials.
  • No additional external dependencies beyond the configured API key and network access to the API.

Troubleshooting

  • Common issues:

    • Invalid or missing API key will cause authentication failures.
    • Incorrect date formats in query parameters may result in API errors or empty responses.
    • Pagination parameters exceeding available pages may return empty datasets.

  • Error messages:

    • "Request failed": General failure in making the HTTP request; check network connectivity and API availability.
    • Errors wrapped as NodeApiError with messages from the API response; verify that all required parameters are correctly set.

  • Resolutions:

    • Ensure the API key credential is correctly configured and active.
    • Validate date strings follow the expected format (usually ISO 8601).
    • Adjust pagination parameters within valid ranges.

Links and References

Discussion