LEDGERS icon

LEDGERS

Interact with LEDGERS API

Overview

This node interacts with the "Sales Operation (India)" resource of an external LEDGERS API to list receipts. It allows users to retrieve a filtered and paginated list of sales receipts based on criteria such as contact ID, date range, and reconciliation status.

Common scenarios where this node is beneficial include:

  • Fetching recent payment receipts for accounting or reconciliation purposes.
  • Filtering receipts by customer or date to generate reports.
  • Monitoring receipt statuses to identify unreconciled or partially reconciled payments.

Practical example:

  • A finance team wants to pull the last 10 fully reconciled receipts for a specific customer within a given month to verify payments received.

Properties

Name Meaning
Limit The maximum number of receipts to return in one request.
Filters Optional filters to narrow down the list of receipts:
- Contact ID Filter receipts by a specific contact's unique identifier.
- Date From Start date to filter receipts from (inclusive).
- Date To End date to filter receipts up to (inclusive).
- Reconcile Status Filter receipts by their reconciliation status. Options: Fully Reconciled, Partially Reconciled, Unreconciled, Deleted.

Output

The node outputs a JSON array of receipt objects matching the specified filters and limit. Each object represents a receipt with its associated data fields as returned by the LEDGERS API.

If the node supports binary data output (not explicitly shown here), it would typically represent attachments or documents related to receipts, but this is not indicated in the provided code or properties.

Dependencies

  • Requires an API key credential and user authentication credentials (email and password) for the LEDGERS API.
  • The node performs login requests to obtain an API token before making further API calls.
  • The base URL for the API is configurable via credentials.
  • Uses HTTP requests to interact with the LEDGERS API endpoints.

Troubleshooting

  • Authentication failures: If the node returns errors about failed login or missing API tokens, verify that the API key, email, and password credentials are correct and have sufficient permissions.
  • Empty or unexpected results: Check that the filter parameters (contact ID, dates, reconcile status) are valid and correspond to existing data in the system.
  • API rate limits or connectivity issues: Network problems or API throttling may cause request failures; ensure stable internet connection and check API usage limits.
  • Invalid property values: Ensure the "Limit" is a positive number and date filters are in the correct format.

Links and References

Discussion