REST API for Latepoint icon

REST API for Latepoint

Consume REST API for LatePoint on Tools

Payments → Get All

AI-generated

Summary

Retrieve a list of payments from the Latepoint system, optionally filtered and paginated according to user-specified criteria.

Inputs

  • Use Filters — Enable or disable predefined filter fields to apply when retrieving payments. When disabled, only Additional Filters (JSON) are used.
  • Filters — A collection of predefined filters such as Customer ID, Order ID, Status, Payment Method, Amount range, Date range, Search term, Sort options, and metadata filters to refine the payments returned. Only shown if Use Filters is enabled.
  • Additional Filters (JSON) — Extra filter parameters expressed as a JSON object with keys matching the API parameter names; applied independently of the Use Filters toggle.
  • Return All — Whether to return all matching payments or only a limited number per page.
  • Max Pages — Maximum pages to retrieve when returning all results; set to 0 for unlimited. Helps control API load with large datasets. Used only if Return All is true.
  • Limit — Maximum number of results to return per page. Used only if Return All is false.
  • Page — Page number to retrieve, with manual pagination when Return All is false.

Output shape

a list of payment records wrapped in JSON objects; pagination metadata is included when not returning all results

If Return All is true, the operation fetches multiple pages up to Max Pages or until no more pages are available. Filters can be combined from predefined filters and Additional Filters (JSON). The response format includes the full API response when paginating, enabling access to pagination info such as total, total_pages, and has_next_page.

Examples

Example 1: Retrieve all payments completed via credit card between two dates, including metadata.

Set Use Filters to true, then set Status to Completed, Payment Method to Credit Card, Date From and Date To for the date range, and toggle Include Meta to true. Set Return All to true to retrieve all matching records.

Links

Discussion