Rest Accounting

Interact with Rest Accounting API
Join our community

Actions13

Overview

This node integrates with the Rest Accounting API to manage accounting data programmatically. Specifically, for the Accounts - List operation, it retrieves a paginated list of accounts from the accounting system. This is useful for scenarios where you want to fetch and process account information such as codes, names, types, or hierarchical relationships in workflows that automate financial reporting, reconciliation, or auditing.

For example, you might use this node to:

  • Retrieve all accounts to generate a custom chart of accounts report.
  • Sync account data into another system for consolidated financial analysis.
  • Filter accounts based on date ranges or pagination to handle large datasets efficiently.

Properties

Name Meaning
Query Parameters Collection of optional filters and pagination settings to refine the list of accounts:
- Start Date Filter accounts starting from this date (string).
- End Date Filter accounts up to this date (string).
- Page The page number to retrieve (number, default 1).
- Page Size Number of accounts per page (number, default 50).

Note: Some query parameters like "Reference" and "Description" are only applicable to other resources/operations and do not affect the Accounts List operation.

Output

The output is an array of JSON objects representing the accounts retrieved from the API. Each item in the output corresponds to one account record with fields as returned by the Rest Accounting API. Typical fields may include account ID, code, name, type, parent account ID, and other metadata.

The node does not output binary data.

Example output structure (simplified):

[
  {
    "id": 123,
    "code": "4000",
    "name": "Sales Revenue",
    "type": "Revenue",
    "parent_id": 0
  },
  {
    "id": 124,
    "code": "5000",
    "name": "Cost of Goods Sold",
    "type": "Expense",
    "parent_id": 0
  }
]

Dependencies

  • Requires an API key credential for authenticating with the Rest Accounting API.
  • The base URL of the API must be configured in the credentials.
  • The node uses HTTP requests with JSON payloads and expects JSON responses.

Troubleshooting

  • Common issues:
    • Invalid or missing API key will cause authentication failures.
    • Incorrect base URL configuration can lead to connection errors.
    • Pagination parameters out of range may return empty results or errors.
  • Error messages:
    • "Request failed" indicates a network or API error; check credentials and connectivity.
    • Errors thrown by the API (e.g., 4xx or 5xx HTTP status) will be wrapped and surfaced by the node.
  • Resolution tips:
    • Verify API key validity and permissions.
    • Confirm the base URL matches the target environment.
    • Adjust pagination parameters to valid values.
    • Inspect detailed error messages for specific API response issues.

Links and References

Discussion