Rest Accounting

Interact with Rest Accounting API
Join our community

Actions13

Overview

This node interacts with a RESTful accounting API to retrieve various financial data and perform accounting operations. Specifically, the Reports - Ledger operation fetches ledger report data for a specified account. This is useful for accountants or finance teams who want to generate detailed ledger reports showing all transactions related to an account within optional date ranges or pagination settings.

Practical examples include:

  • Generating a ledger report for a specific account to review all debit and credit entries.
  • Filtering ledger entries by date range to analyze monthly or quarterly activity.
  • Paginating through large ledger datasets for efficient processing.

Properties

Name Meaning
Account ID The unique numeric identifier of the ledger account for which the report will be generated.
Query Parameters Optional filters and pagination controls for the ledger report:
- Start Date: Filter entries from this date (string).
- End Date: Filter entries up to this date (string).
- Page: The page number for paginated results (number).
- Page Size: Number of entries per page (number).

Note: Some query parameters like "Reference" and "Description" exist but are only applicable to other resources/operations and thus not relevant here.

Output

The node outputs JSON data representing the ledger report retrieved from the API. The structure typically includes details such as:

  • Account information
  • List of ledger entries with transaction dates, amounts, references, descriptions, and balances
  • Pagination metadata if applicable

If the API supports binary data for reports (e.g., PDF exports), it would be handled separately, but in this implementation, only JSON responses are returned.

Dependencies

  • Requires an API key credential for authenticating requests to the external Rest Accounting API.
  • The base URL and API key must be configured in the node's credentials.
  • No additional environment variables are required.

Troubleshooting

  • Common issues:

    • Invalid or missing API key credential will cause authentication failures.
    • Providing an invalid Account ID may result in "not found" errors.
    • Incorrect date formats in query parameters might lead to API errors or empty results.
    • Pagination parameters out of range could return empty pages.

  • Error messages:

    • "Request failed": Generic error indicating the HTTP request to the API did not succeed. Check network connectivity and API availability.
    • Errors wrapped in NodeApiError usually contain the API's error message; verify that input parameters conform to expected formats and values.

Links and References

Discussion