Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Rate Factor → Get Collection

AI-generated

Summary

Retrieve a paginated collection of Rate Factor records from Rentman with optional filtering, sorting, field selection, and nested expansion of related item/link fields.

Inputs

  • Expand — Provide a comma-separated list of linkable fields (up to 3 levels with dot notation) to expand inline in the response instead of returning just their paths.
  • Return All — Set to true to return all records without limiting the number, or false to limit the results.
  • Limit — When Return All is false, specify the maximum number of records to return (minimum 1).
  • Offset — When Return All is false, specify the number of records to skip for offset-based pagination.
  • Filters — Optionally filter records by criteria such as Created After date, Modified After/Before dates, ID greater than a specified value, select specific fields to return, and sort order.
  • Custom Query Parameters — Add custom query parameters for additional filtering, including relational operators, by specifying key-value pairs.

Output shape

a list of Rate Factor records with their fields and any expanded linked fields, returned in a paginated response.

Supports pagination controlled by Return All, Limit, and Offset parameters. The 'expand' parameter can inline related linked fields up to 3 nested levels. Filters and custom query parameters refine the returned collection. Errors or empty sets depend on Rentman API responses.

Links

Discussion