Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Payment → Get Collection

AI-generated

Summary

Retrieve a collection of Payment records from the Rentman API, supporting pagination, filtering, sorting, field selection, and inline expansion of linked fields.

Inputs

  • Expand — Comma-separated list of linked fields to inline in the response, supporting nested expansion up to 3 levels using dot notation.
  • Return All — Boolean to indicate whether to return all results or limit them.
  • Limit — Maximum number of Payment records to return (applicable if Return All is false).
  • Offset — Number of records to skip for pagination offset (used if Return All is false).
  • Filters — Optional filters to restrict results such as creation date, modification date, ID greater than a value, selected fields, and sort order.
  • Custom Query Parameters — Additional custom query parameters for filtering on arbitrary fields or using relational operators.
  • Request Options — Advanced options including batching, SSL certificate handling, proxy, and request timeout.

Output shape

a list of Payment objects

The returned collection respects the specified limit, offset, filters, and expansions. Pagination is supported via next_page_url if Return All is true. Expanded fields inline linked item data instead of paths. Errors or empty responses will be propagated as per standard node behavior.

Examples

Example 1: Retrieve up to 50 Payment records created after January 1, 2023, including inline expanded equipment data.

Set 'Created After' filter to 2023-01-01, set limit to 50, and set Expand to 'equipment'.

Links

Discussion