Rentman icon

Rentman

Interact with the Rentman rental management API

Actions206

Purchase Order → Get Order Costs

AI-generated

Summary

Retrieve the costs associated with a specific purchase order from Rentman, optionally expanding linked fields and filtering results.

Inputs

  • purchaseOrderId (required) — The ID of the purchase order to retrieve costs for.
  • expand — Comma-separated list of linkable fields to inline in the response, supporting up to 3 levels of nested expansion (e.g., equipment,equipment.creator).
  • returnAll — Boolean indicating whether to return all results or limit the number of results returned.
  • limit — Maximum number of results to return if 'returnAll' is false.
  • offset — Number of results to skip for offset-based pagination if 'returnAll' is false.
  • filters — Optional filters to apply on the returned costs, including fields such as created after, modified after/before, ID greater than, approval status, supplier path, sort order, and specific fields to return.

Output shape

a list of purchase order cost items, potentially paginated if 'returnAll' is false.

Supports pagination using 'returnAll', 'limit', and 'offset'. The 'expand' parameter can inline related linked items in the response up to 3 nested levels. Returned data can be filtered using the available filter options.

Examples

Example 1: Fetch all costs for a purchase order with full detail including equipment creator info

Set purchaseOrderId; set expand to 'equipment,equipment.creator'; set returnAll to true.

Example 2: Fetch first 50 costs for a purchase order filtered by approval status 'approved' after 2023-01-01

Set purchaseOrderId; set returnAll to false; set limit to 50; set filters.created_gt to '2023-01-01'; set filters.approval_status to 'approved'.

Links

Discussion