Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Invoice → Get Collection

AI-generated

Summary

Retrieve a list of Invoice records from Rentman, optionally applying filters, pagination, and field expansions to customize the returned data.

Inputs

  • Expand — Comma-separated list of related item/link fields to inline in the response instead of returning as paths. Supports dot notation for nesting up to 3 levels (e.g., 'equipment,equipment.creator').
  • Return All — Boolean indicating whether to fetch all matching invoices or limit the number of results.
  • Limit — Maximum number of invoice records to return when not returning all results (default 50).
  • Offset — Number of matching invoice records to skip for offset-based pagination (default 0).
  • Filters — Multiple optional filters including 'Created After', 'Modified After', 'Modified Before', 'ID Greater Than', 'Invoice Number', 'Sort', and 'Fields' to restrict and order the results.
  • Custom Query Parameters — Custom key-value query parameters for additional filtering or applying relational operators (e.g., field[gt]=value).
  • Request Options — Node-level options for batching, SSL, proxy, and timeout behavior.

Output shape

a list of Invoice objects matching the specified query parameters and filters

Supports pagination controlled via 'Return All', 'Limit', and 'Offset' inputs. The 'Expand' input enables inclusion of linked resource details inline. Filters allow refined queries. The output array may be empty if no records match.

Examples

Example 1: Fetch all invoices created after January 1, 2024, including expanded equipment and the equipment creator details, returning all matching entries.

Set 'Created After' filter to '2024-01-01T00:00:00Z', 'Expand' to 'equipment,equipment.creator', and enable 'Return All'.

Links

Discussion