REST API for Latepoint icon

REST API for Latepoint

Consume REST API for LatePoint on Tools
Join our community

Actions40

Overview

This node interacts with the LatePoint REST API to retrieve payment records based on various filter criteria. The "Get All" operation for the "Payments" resource allows users to fetch multiple payment entries, optionally filtered and sorted by different parameters such as customer ID, booking ID, status, payment method, amount range, date range, and metadata keys/values.

Common scenarios where this node is beneficial include:

  • Retrieving all payments made by a specific customer or related to a particular booking.
  • Filtering payments by their status (e.g., completed, pending, refunded) to generate reports or trigger workflows.
  • Searching payments by transaction IDs or notes for audit or reconciliation purposes.
  • Sorting payments by date or amount to analyze recent transactions or high-value payments.

Practical example:

  • A business wants to automatically fetch all completed credit card payments above $100 made in the last month to update their accounting system.
  • Another use case could be retrieving all pending payments to send reminders to customers.

Properties

Name Meaning
Filters Collection of filters to apply when retrieving payments. Options include:
• Customer ID: Filter payments by customer ID
• Booking ID: Filter payments by booking ID
• Status: Completed, Pending, Failed, Refunded
• Payment Method: Cash, Credit Card, PayPal, Stripe
• Amount Min: Minimum payment amount
• Amount Max: Maximum payment amount
• Date From: Start date for filtering payments (YYYY-MM-DD)
• Date To: End date for filtering payments (YYYY-MM-DD)
• Search: Text search across payment fields like transaction ID or notes
• Sort By: Field to sort results by (ID, Amount, Date, Status)
• Sort Order: Ascending or Descending order
• Include Meta: Whether to include payment metadata in the response
• Meta Key: Filter by specific metadata key
• Meta Value: Filter by specific metadata value
Description Optional text description or prompt to provide context or purpose for the API call.
Return All Boolean flag indicating whether to return all matching results or limit the number of results returned.
Limit When "Return All" is false, limits the maximum number of results returned (1 to 100). Default is 10.

Output

The node outputs an array of JSON objects representing payment records retrieved from the LatePoint API. Each object corresponds to a single payment and includes fields such as:

  • Payment identifiers (e.g., payment ID)
  • Customer ID associated with the payment
  • Booking ID linked to the payment
  • Payment status (completed, pending, failed, refunded)
  • Payment method used (cash, credit card, PayPal, Stripe)
  • Amount paid
  • Transaction ID from the payment processor
  • Notes or additional information
  • Metadata if requested via the "Include Meta" option

If the API returns multiple payments, each is output as a separate item in the node's output array.

The node does not output binary data.

Dependencies

  • Requires configuration of an API authentication token credential for the LatePoint REST API.
  • The base URL and API key must be set in the node credentials.
  • The node makes HTTP requests to the LatePoint API endpoints using these credentials.

Troubleshooting

  • No credentials configured!
    This error occurs if the required API authentication token is missing or not configured properly. Ensure that the LatePoint API credentials are set up correctly in n8n.

  • Invalid JSON in body (not typical for Get All but possible in other operations)
    If you switch to sending a custom JSON body and it contains invalid JSON syntax, the node will throw this error. Validate JSON format before input.

  • Empty or no results returned
    Check your filter criteria; overly restrictive filters may result in no matching payments. Also verify that the API key has sufficient permissions.

  • API rate limits or connectivity issues
    Network problems or API rate limiting can cause request failures. Retry after some time or check network connectivity.

Links and References

Discussion